|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +require 'spec_helper' |
| 4 | + |
| 5 | +describe DatadogBackup::Workflows do |
| 6 | + let(:stubs) { Faraday::Adapter::Test::Stubs.new } |
| 7 | + let(:api_client_double) { Faraday.new { |f| f.adapter :test, stubs } } |
| 8 | + let(:tempdir) { Dir.mktmpdir } |
| 9 | + let(:workflows) do |
| 10 | + workflows = described_class.new( |
| 11 | + action: 'backup', |
| 12 | + backup_dir: tempdir, |
| 13 | + output_format: :json, |
| 14 | + resources: [] |
| 15 | + ) |
| 16 | + allow(workflows).to receive(:api_service).and_return(api_client_double) |
| 17 | + return workflows |
| 18 | + end |
| 19 | + let(:workflow_abc_123) do |
| 20 | + { |
| 21 | + 'id' => 'abc-123-def', |
| 22 | + 'attributes' => { |
| 23 | + 'name' => 'Test Workflow', |
| 24 | + 'description' => 'A test workflow for CI/CD', |
| 25 | + 'steps' => [ |
| 26 | + { |
| 27 | + 'name' => 'step_1', |
| 28 | + 'action' => 'com.datadoghq.http', |
| 29 | + 'params' => { |
| 30 | + 'url' => 'https://example.com/api', |
| 31 | + 'method' => 'POST' |
| 32 | + } |
| 33 | + } |
| 34 | + ], |
| 35 | + 'triggers' => [ |
| 36 | + { |
| 37 | + 'type' => 'schedule', |
| 38 | + 'schedule' => '0 9 * * 1-5' |
| 39 | + } |
| 40 | + ] |
| 41 | + }, |
| 42 | + 'created_at' => '2024-01-01T00:00:00Z', |
| 43 | + 'modified_at' => '2024-01-02T00:00:00Z', |
| 44 | + 'last_executed_at' => '2024-01-03T00:00:00Z' |
| 45 | + } |
| 46 | + end |
| 47 | + let(:workflow_xyz_456) do |
| 48 | + { |
| 49 | + 'id' => 'xyz-456-ghi', |
| 50 | + 'attributes' => { |
| 51 | + 'name' => 'Another Workflow', |
| 52 | + 'description' => 'Another test workflow', |
| 53 | + 'steps' => [], |
| 54 | + 'triggers' => [] |
| 55 | + }, |
| 56 | + 'created_at' => '2024-02-01T00:00:00Z', |
| 57 | + 'modified_at' => '2024-02-02T00:00:00Z' |
| 58 | + } |
| 59 | + end |
| 60 | + let(:workflow_abc_123_clean) do |
| 61 | + { |
| 62 | + 'id' => 'abc-123-def', |
| 63 | + 'attributes' => { |
| 64 | + 'name' => 'Test Workflow', |
| 65 | + 'description' => 'A test workflow for CI/CD', |
| 66 | + 'steps' => [ |
| 67 | + { |
| 68 | + 'name' => 'step_1', |
| 69 | + 'action' => 'com.datadoghq.http', |
| 70 | + 'params' => { |
| 71 | + 'url' => 'https://example.com/api', |
| 72 | + 'method' => 'POST' |
| 73 | + } |
| 74 | + } |
| 75 | + ], |
| 76 | + 'triggers' => [ |
| 77 | + { |
| 78 | + 'type' => 'schedule', |
| 79 | + 'schedule' => '0 9 * * 1-5' |
| 80 | + } |
| 81 | + ] |
| 82 | + } |
| 83 | + } |
| 84 | + end |
| 85 | + let(:workflow_xyz_456_clean) do |
| 86 | + { |
| 87 | + 'id' => 'xyz-456-ghi', |
| 88 | + 'attributes' => { |
| 89 | + 'name' => 'Another Workflow', |
| 90 | + 'description' => 'Another test workflow', |
| 91 | + 'steps' => [], |
| 92 | + 'triggers' => [] |
| 93 | + } |
| 94 | + } |
| 95 | + end |
| 96 | + let(:fetched_workflows) do |
| 97 | + { |
| 98 | + 'data' => [workflow_abc_123, workflow_xyz_456] |
| 99 | + } |
| 100 | + end |
| 101 | + let(:workflow_abc_123_response) do |
| 102 | + { 'data' => workflow_abc_123 } |
| 103 | + end |
| 104 | + let(:workflow_xyz_456_response) do |
| 105 | + { 'data' => workflow_xyz_456 } |
| 106 | + end |
| 107 | + let(:all_workflows) { respond_with200(fetched_workflows) } |
| 108 | + let(:example_workflow1) { respond_with200(workflow_abc_123_response) } |
| 109 | + let(:example_workflow2) { respond_with200(workflow_xyz_456_response) } |
| 110 | + |
| 111 | + before do |
| 112 | + stubs.get('/api/v2/workflows') { all_workflows } |
| 113 | + stubs.get('/api/v2/workflows/abc-123-def') { example_workflow1 } |
| 114 | + stubs.get('/api/v2/workflows/xyz-456-ghi') { example_workflow2 } |
| 115 | + end |
| 116 | + |
| 117 | + after do |
| 118 | + FileUtils.remove_entry tempdir |
| 119 | + end |
| 120 | + |
| 121 | + describe '#backup' do |
| 122 | + subject { workflows.backup } |
| 123 | + |
| 124 | + it 'is expected to create two files' do |
| 125 | + file1 = instance_double(File) |
| 126 | + allow(File).to receive(:open).with(workflows.filename('abc-123-def'), 'w').and_return(file1) |
| 127 | + allow(file1).to receive(:write) |
| 128 | + allow(file1).to receive(:close) |
| 129 | + |
| 130 | + file2 = instance_double(File) |
| 131 | + allow(File).to receive(:open).with(workflows.filename('xyz-456-ghi'), 'w').and_return(file2) |
| 132 | + allow(file2).to receive(:write) |
| 133 | + allow(file2).to receive(:close) |
| 134 | + |
| 135 | + workflows.backup |
| 136 | + expect(file1).to have_received(:write).with(::JSON.pretty_generate(workflow_abc_123_clean.deep_sort)) |
| 137 | + expect(file2).to have_received(:write).with(::JSON.pretty_generate(workflow_xyz_456_clean.deep_sort)) |
| 138 | + end |
| 139 | + end |
| 140 | + |
| 141 | + describe '#filename' do |
| 142 | + subject { workflows.filename('abc-123-def') } |
| 143 | + |
| 144 | + it { is_expected.to eq("#{tempdir}/workflows/abc-123-def.json") } |
| 145 | + end |
| 146 | + |
| 147 | + describe '#get_by_id' do |
| 148 | + subject { workflows.get_by_id('abc-123-def') } |
| 149 | + |
| 150 | + it { is_expected.to eq workflow_abc_123_clean } |
| 151 | + end |
| 152 | + |
| 153 | + describe '#all' do |
| 154 | + subject { workflows.all } |
| 155 | + |
| 156 | + it 'returns array of workflows' do |
| 157 | + expect(subject).to eq([workflow_abc_123, workflow_xyz_456]) |
| 158 | + end |
| 159 | + end |
| 160 | + |
| 161 | + describe '#diff' do |
| 162 | + it 'calls the api only once' do |
| 163 | + workflows.write_file('{"a":"b"}', workflows.filename('abc-123-def')) |
| 164 | + expect(workflows.diff('abc-123-def')).to eq(<<~EODASH |
| 165 | + --- |
| 166 | + -attributes: |
| 167 | + - description: A test workflow for CI/CD |
| 168 | + - name: Test Workflow |
| 169 | + - steps: |
| 170 | + - - action: com.datadoghq.http |
| 171 | + - name: step_1 |
| 172 | + - params: |
| 173 | + - method: POST |
| 174 | + - url: https://example.com/api |
| 175 | + - triggers: |
| 176 | + - - schedule: 0 9 * * 1-5 |
| 177 | + - type: schedule |
| 178 | + -id: abc-123-def |
| 179 | + +a: b |
| 180 | + EODASH |
| 181 | + .chomp) |
| 182 | + end |
| 183 | + end |
| 184 | + |
| 185 | + describe '#except' do |
| 186 | + subject { workflows.except({ :a => :b, 'created_at' => :c, 'modified_at' => :d, 'last_executed_at' => :e }) } |
| 187 | + |
| 188 | + it { is_expected.to eq({ a: :b }) } |
| 189 | + end |
| 190 | + |
| 191 | + describe 'private methods' do |
| 192 | + it 'uses v2 API' do |
| 193 | + expect(workflows.send(:api_version)).to eq('v2') |
| 194 | + end |
| 195 | + |
| 196 | + it 'uses workflows resource name' do |
| 197 | + expect(workflows.send(:api_resource_name)).to eq('workflows') |
| 198 | + end |
| 199 | + |
| 200 | + it 'uses id as id_keyname' do |
| 201 | + expect(workflows.send(:id_keyname)).to eq('id') |
| 202 | + end |
| 203 | + end |
| 204 | +end |
0 commit comments