openapi_first/spec/test/coverage/plan_spec.rb at 4f4e364dbe75dba6b0f3efdca40c62d2ecdf83af · ahx/openapi_first · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# frozen_string_literal: true

RSpec.describe OpenapiFirst::Test::Coverage::Plan do
  let(:spec) do
    {
      'openapi' => '3.1.0',
      'paths' => {
        '/stuff/{id}' => {
          'parameters' => [
            {
              'name' => 'id',
              'in' => 'path',
              'required' => true,
              'schema' => {
                'type' => 'integer'
              }
            }
          ],
          'get' => {
            'responses' => {
              '200' => {
                'content' => {
                  'application/json' => {
                    'schema' => {
                      'type' => 'object'
                    }
                  }
                }
              },
              '4XX' => {
                'content' => {
                  'application/json' => {
                    'schema' => {
                      'type' => 'object'
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  end

  let(:oad) { OpenapiFirst.parse(spec, filepath: 'myopenapi.yaml') }

  let(:valid_request) do
    request = Rack::Request.new(Rack::MockRequest.env_for('/stuff/24'))
    oad.validate_request(request)
  end

  let(:valid_response) do
    request = Rack::Request.new(Rack::MockRequest.env_for('/stuff/24'))
    response = Rack::Response.new
    response.content_type = 'application/json'
    response.write JSON.generate({})
    oad.validate_response(request, response)
  end

  let(:valid_400_response) do
    request = Rack::Request.new(Rack::MockRequest.env_for('/stuff/24'))
    response = Rack::Response.new
    response.status = 400
    response.content_type = 'application/json'
    response.write JSON.generate({})
    oad.validate_response(request, response)
  end

  subject(:plan) { described_class.for(oad) }

  it 'tracks requests and responses' do
    request = plan.routes.first.requests.first
    expect(request.requested?).to be(false)

    plan.track_request(valid_request)

    expect(request.requested?).to be(true)

    response = plan.routes.first.responses.first
    expect(response.responded?).to be(false)

    plan.track_response(valid_response)

    expect(response.responded?).to be(true)
  end

  it 'ignores unknown requests' do
    request = Rack::Request.new(Rack::MockRequest.env_for('/unknown/24'))
    plan.track_request(oad.validate_request(request))
    expect(plan.coverage).to eq(0)
  end

  it 'ignores unknown responses' do
    request = Rack::Request.new(Rack::MockRequest.env_for('/stuff/24'))
    response = Rack::Response.new
    response.status = 309
    plan.track_response(oad.validate_response(request, response))
    expect(plan.coverage).to eq(0)
  end

  it 'returns coverage in percentage' do
    expect(plan.coverage).to eq(0)

    plan.track_request(valid_request)
    plan.track_response(valid_response)
    expect(plan.coverage).to eq(66.66666666666667)
    plan.track_response(valid_400_response)

    expect(plan.coverage).to eq(100)
  end

  it 'can be done' do
    expect(plan).not_to be_done

    plan.track_request(valid_request)
    plan.track_response(valid_response)
    plan.track_response(valid_400_response)

    expect(plan).to be_done
  end

  it 'has tasks, finished and unfinished' do
    expect(plan.tasks.count).to eq(3)

    expect(plan.tasks.count(&:finished?)).to eq(0)

    plan.track_request(valid_request)
    plan.track_response(valid_response)
    plan.track_response(valid_400_response)

    expect(plan.tasks.count(&:finished?)).to eq(3)
  end

  it 'has ordered tasks' do
    expect(plan.tasks[0].path).to eq('/stuff/{id}')
    expect(plan.tasks[1].status).to eq('200')
    expect(plan.tasks[2].status).to eq('4XX')
  end

  context 'with skip_response option' do
    let(:plan) do
      skip_response = ->(response) { response.status == '4XX' }
      described_class.for(oad, skip_response:)
    end

    it 'can be done without the skipped response' do
      expect(plan).not_to be_done

      plan.track_request(valid_request)
      plan.track_response(valid_response)

      expect(plan.coverage).to eq(100)
    end
  end
end