debian-mirror-gitlab/spec/lib/gitlab/graphql/docs/renderer_spec.rb

127 lines
3.4 KiB
Ruby
Raw Normal View History

2020-04-08 14:13:33 +05:30
# frozen_string_literal: true
require 'spec_helper'
2020-07-28 23:09:34 +05:30
RSpec.describe Gitlab::Graphql::Docs::Renderer do
2020-04-08 14:13:33 +05:30
describe '#contents' do
# Returns a Schema that uses the given `type`
def mock_schema(type)
2020-04-22 19:07:51 +05:30
query_type = Class.new(Types::BaseObject) do
2020-04-08 14:13:33 +05:30
graphql_name 'QueryType'
field :foo, type, null: true
end
GraphQL::Schema.define(query: query_type)
end
let_it_be(:template) { Rails.root.join('lib/gitlab/graphql/docs/templates/', 'default.md.haml') }
subject(:contents) do
described_class.new(
mock_schema(type).graphql_definition,
output_dir: nil,
template: template
).contents
end
context 'A type with a field with a [Array] return type' do
let(:type) do
2020-04-22 19:07:51 +05:30
Class.new(Types::BaseObject) do
2020-04-08 14:13:33 +05:30
graphql_name 'ArrayTest'
field :foo, [GraphQL::STRING_TYPE], null: false, description: 'A description'
end
end
specify do
expectation = <<~DOC
2020-11-24 15:15:51 +05:30
### ArrayTest
2020-04-08 14:13:33 +05:30
2020-11-24 15:15:51 +05:30
| Field | Type | Description |
| ----- | ---- | ----------- |
2020-04-08 14:13:33 +05:30
| `foo` | String! => Array | A description |
DOC
is_expected.to include(expectation)
end
end
context 'A type with fields defined in reverse alphabetical order' do
let(:type) do
2020-04-22 19:07:51 +05:30
Class.new(Types::BaseObject) do
2020-04-08 14:13:33 +05:30
graphql_name 'OrderingTest'
field :foo, GraphQL::STRING_TYPE, null: false, description: 'A description of foo field'
field :bar, GraphQL::STRING_TYPE, null: false, description: 'A description of bar field'
end
end
specify do
expectation = <<~DOC
2020-11-24 15:15:51 +05:30
### OrderingTest
2020-04-08 14:13:33 +05:30
2020-11-24 15:15:51 +05:30
| Field | Type | Description |
| ----- | ---- | ----------- |
2020-04-08 14:13:33 +05:30
| `bar` | String! | A description of bar field |
| `foo` | String! | A description of foo field |
DOC
is_expected.to include(expectation)
end
end
context 'A type with a deprecated field' do
let(:type) do
2020-04-22 19:07:51 +05:30
Class.new(Types::BaseObject) do
2020-04-08 14:13:33 +05:30
graphql_name 'DeprecatedTest'
2020-04-22 19:07:51 +05:30
field :foo, GraphQL::STRING_TYPE, null: false, deprecated: { reason: 'This is deprecated', milestone: '1.10' }, description: 'A description'
2020-04-08 14:13:33 +05:30
end
end
specify do
expectation = <<~DOC
2020-11-24 15:15:51 +05:30
### DeprecatedTest
2020-04-08 14:13:33 +05:30
2020-11-24 15:15:51 +05:30
| Field | Type | Description |
| ----- | ---- | ----------- |
2020-04-22 19:07:51 +05:30
| `foo` **{warning-solid}** | String! | **Deprecated:** This is deprecated. Deprecated in 1.10 |
2020-04-08 14:13:33 +05:30
DOC
is_expected.to include(expectation)
end
end
2020-11-24 15:15:51 +05:30
context 'A type with an emum field' do
let(:type) do
enum_type = Class.new(Types::BaseEnum) do
graphql_name 'MyEnum'
value 'BAZ', description: 'A description of BAZ'
value 'BAR', description: 'A description of BAR', deprecated: { reason: 'This is deprecated', milestone: '1.10' }
end
Class.new(Types::BaseObject) do
graphql_name 'EnumTest'
field :foo, enum_type, null: false, description: 'A description of foo field'
end
end
specify do
expectation = <<~DOC
### MyEnum
| Value | Description |
| ----- | ----------- |
| `BAR` **{warning-solid}** | **Deprecated:** This is deprecated. Deprecated in 1.10 |
| `BAZ` | A description of BAZ |
DOC
is_expected.to include(expectation)
end
end
2020-04-08 14:13:33 +05:30
end
end