datadog_backup 3.0.0 → 3.1.0

data/spec/datadog_backup/local_filesystem_spec.rb

@@ -68,13 +68,13 @@ describe DatadogBackup::LocalFilesystem do
   end
 
   describe '#dump' do
-    context ':json' do
+    context 'when mode is :json' do
       subject { core.dump({ a: :b }) }
 
       it { is_expected.to eq(%({\n  "a": "b"\n})) }
     end
 
-    context ':yaml' do
+    context 'when mode is :yaml' do
       subject { core_yaml.dump({ 'a' => 'b' }) }
 
       it { is_expected.to eq(%(---\na: b\n)) }
@@ -82,13 +82,13 @@ describe DatadogBackup::LocalFilesystem do
   end
 
   describe '#filename' do
-    context ':json' do
+    context 'when mode is :json' do
       subject { core.filename('abc-123-def') }
 
       it { is_expected.to eq("#{tempdir}/core/abc-123-def.json") }
     end
 
-    context ':yaml' do
+    context 'when mode is :yaml' do
       subject { core_yaml.filename('abc-123-def') }
 
       it { is_expected.to eq("#{tempdir}/core/abc-123-def.yaml") }
@@ -124,13 +124,13 @@ describe DatadogBackup::LocalFilesystem do
   end
 
   describe '#load_from_file' do
-    context ':json' do
+    context 'when mode is :json' do
       subject { core.load_from_file(%({\n  "a": "b"\n}), :json) }
 
       it { is_expected.to eq('a' => 'b') }
     end
 
-    context ':yaml' do
+    context 'when mode is :yaml' do
       subject { core.load_from_file(%(---\na: b\n), :yaml) }
 
       it { is_expected.to eq('a' => 'b') }
@@ -138,7 +138,7 @@ describe DatadogBackup::LocalFilesystem do
   end
 
   describe '#load_from_file_by_id' do
-    context 'written in json read in yaml mode' do
+    context 'when the backup is in json but the mode is :yaml' do
       subject { core_yaml.load_from_file_by_id('abc-123-def') }
 
       before { core.write_file(%({"a": "b"}), "#{tempdir}/core/abc-123-def.json") }
@@ -148,7 +148,7 @@ describe DatadogBackup::LocalFilesystem do
       it { is_expected.to eq('a' => 'b') }
     end
 
-    context 'written in yaml read in json mode' do
+    context 'when the backup is in yaml but the mode is :json' do
       subject { core.load_from_file_by_id('abc-123-def') }
 
       before { core.write_file(%(---\na: b), "#{tempdir}/core/abc-123-def.yaml") }
@@ -158,7 +158,7 @@ describe DatadogBackup::LocalFilesystem do
       it { is_expected.to eq('a' => 'b') }
     end
 
-    context 'Integer as parameter' do
+    context 'with Integer as parameter' do
       subject { core.load_from_file_by_id(12_345) }
 
       before { core.write_file(%(---\na: b), "#{tempdir}/core/12345.yaml") }
@@ -170,9 +170,9 @@ describe DatadogBackup::LocalFilesystem do
   end
 
   describe '#write_file' do
-    subject { core.write_file('abc123', "#{tempdir}/core/abc-123-def.json") }
+    subject(:write_file) { core.write_file('abc123', "#{tempdir}/core/abc-123-def.json") }
 
-    let(:file_like_object) { double }
+    let(:file_like_object) { instance_double(File) }
 
     it 'writes a file to abc-123-def.json' do
       allow(File).to receive(:open).and_call_original
@@ -180,7 +180,7 @@ describe DatadogBackup::LocalFilesystem do
       allow(file_like_object).to receive(:write)
       allow(file_like_object).to receive(:close)
 
-      subject
+      write_file
 
       expect(file_like_object).to have_received(:write).with('abc123')
     end

data/spec/datadog_backup/monitors_spec.rb

@@ -16,7 +16,6 @@ describe DatadogBackup::Monitors do
     allow(monitors).to receive(:api_service).and_return(api_client_double)
     return monitors
   end
-
   let(:monitor_description) do
     {
       'query' => 'bar',
@@ -35,30 +34,16 @@ describe DatadogBackup::Monitors do
       'query' => 'bar'
     }
   end
-  let(:all_monitors) do
-    [
-      200,
-      {},
-      [
-        monitor_description
-      ]
-    ]
-  end
-  let(:example_monitor) do
-    [
-      200,
-      {},
-      monitor_description
-    ]
-  end
+  let(:all_monitors) { respond_with200([monitor_description]) }
+  let(:example_monitor) { respond_with200(monitor_description) }
 
   before do
     stubs.get('/api/v1/monitor') { all_monitors }
     stubs.get('/api/v1/dashboard/123455') { example_monitor }
   end
 
-  describe '#all_monitors' do
-    subject { monitors.all_monitors }
+  describe '#get_all' do
+    subject { monitors.get_all }
 
     it { is_expected.to eq [monitor_description] }
   end
@@ -67,22 +52,21 @@ describe DatadogBackup::Monitors do
     subject { monitors.backup }
 
     it 'is expected to create a file' do
-      file = double('file')
+      file = instance_double(File)
       allow(File).to receive(:open).with(monitors.filename(123_455), 'w').and_return(file)
-      expect(file).to receive(:write).with(::JSON.pretty_generate(clean_monitor_description))
+      allow(file).to receive(:write)
       allow(file).to receive(:close)
 
       monitors.backup
+      expect(file).to have_received(:write).with(::JSON.pretty_generate(clean_monitor_description))
     end
   end
 
   describe '#diff and #except' do
     example 'it ignores `overall_state` and `overall_state_modified`' do
       monitors.write_file(monitors.dump(monitor_description), monitors.filename(123_455))
-      stubs.get('/api/v1/dashboard/123455') {
-        [
-          200,
-          {},
+      stubs.get('/api/v1/dashboard/123455') do
+        respond_with200(
           [
             {
               'query' => 'bar',
@@ -93,8 +77,8 @@ describe DatadogBackup::Monitors do
               'overall_state_modified' => '9999-07-27T22:55:55+00:00'
             }
           ]
-        ]
-      }
+        )
+      end
 
       expect(monitors.diff(123_455)).to eq ''
 
@@ -109,13 +93,13 @@ describe DatadogBackup::Monitors do
   end
 
   describe '#get_by_id' do
-    context 'Integer' do
+    context 'when Integer' do
       subject { monitors.get_by_id(123_455) }
 
       it { is_expected.to eq monitor_description }
     end
 
-    context 'String' do
+    context 'when String' do
       subject { monitors.get_by_id('123455') }
 
       it { is_expected.to eq monitor_description }

data/spec/datadog_backup/synthetics_spec.rb

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DatadogBackup::Synthetics do
+  let(:stubs) { Faraday::Adapter::Test::Stubs.new }
+  let(:api_client_double) { Faraday.new { |f| f.adapter :test, stubs } }
+  let(:tempdir) { Dir.mktmpdir } # TODO: delete afterward
+  let(:synthetics) do
+    synthetics = described_class.new(
+      action: 'backup',
+      backup_dir: tempdir,
+      output_format: :json,
+      resources: []
+    )
+    allow(synthetics).to receive(:api_service).and_return(api_client_double)
+    return synthetics
+  end
+  let(:api_test) do
+    { 'config' => { 'assertions' => [{ 'operator' => 'contains', 'property' => 'set-cookie', 'target' => '_user_id', 'type' => 'header' },
+                                     { 'operator' => 'contains', 'target' => 'body message', 'type' => 'body' },
+                                     { 'operator' => 'is', 'property' => 'content-type', 'target' => 'text/html; charset=utf-8', 'type' => 'header' },
+                                     { 'operator' => 'is', 'target' => 200, 'type' => 'statusCode' },
+                                     { 'operator' => 'lessThan', 'target' => 5000, 'type' => 'responseTime' }],
+                    'request' => { 'headers' => { 'User-Agent' => 'Mozilla/5.0 (X11; Fedora; Linux x86_64; rv:65.0) Gecko/20100101 Firefox/65.0',
+                                                  'cookie' => '_a=12345; _example_session=abc123' },
+                                   'method' => 'GET',
+                                   'url' => 'https://www.example.com/' } },
+      'creator' => { 'email' => 'user@example.com', 'handle' => 'user@example.com', 'name' => 'Hugh Zer' },
+      'locations' => ['aws:ap-northeast-1', 'aws:eu-central-1', 'aws:eu-west-2', 'aws:us-west-2'],
+      'message' => 'TEST: This is a test',
+      'monitor_id' => 12_345,
+      'name' => 'TEST: This is a test',
+      'options' => { 'follow_redirects' => true,
+                     'httpVersion' => 'http1',
+                     'min_failure_duration' => 120,
+                     'min_location_failed' => 2,
+                     'monitor_options' => { 'renotify_interval' => 0 },
+                     'monitor_priority' => 1,
+                     'retry' => { 'count' => 1, 'interval' => 500 },
+                     'tick_every' => 120 },
+      'public_id' => 'abc-123-def',
+      'status' => 'live',
+      'subtype' => 'http',
+      'tags' => ['env:test'],
+      'type' => 'api' }
+  end
+  let(:browser_test) do
+    { 'config' => { 'assertions' => [],
+                    'configVariables' => [],
+                    'request' => { 'headers' => {}, 'method' => 'GET', 'url' => 'https://www.example.com' },
+                    'setCookie' => nil,
+                    'variables' => [] },
+      'creator' => { 'email' => 'user@example.com',
+                     'handle' => 'user@example.com',
+                     'name' => 'Hugh Zer' },
+      'locations' => ['aws:us-east-2'],
+      'message' => 'Test message',
+      'monitor_id' => 12_345,
+      'name' => 'www.example.com',
+      'options' => { 'ci' => { 'executionRule' => 'non_blocking' },
+                     'device_ids' => ['chrome.laptop_large', 'chrome.mobile_small'],
+                     'disableCors' => false,
+                     'disableCsp' => false,
+                     'ignoreServerCertificateError' => false,
+                     'min_failure_duration' => 300,
+                     'min_location_failed' => 1,
+                     'monitor_options' => { 'renotify_interval' => 0 },
+                     'noScreenshot' => false,
+                     'retry' => { 'count' => 0, 'interval' => 1000 },
+                     'tick_every' => 900 },
+      'public_id' => '456-ghi-789',
+      'status' => 'live',
+      'tags' => ['env:test'],
+      'type' => 'browser' }
+  end
+  let(:all_synthetics) { respond_with200({ 'tests' => [api_test, browser_test] }) }
+  let(:api_synthetic) { respond_with200(api_test) }
+  let(:browser_synthetic) { respond_with200(browser_test) }
+
+  before do
+    stubs.get('/api/v1/synthetics/tests') { all_synthetics }
+    stubs.get('/api/v1/synthetics/tests/api/abc-123-def') { api_synthetic }
+    stubs.get('/api/v1/synthetics/tests/browser/456-ghi-789') { browser_synthetic }
+  end
+
+  describe '#all' do
+    subject { synthetics.all }
+
+    it { is_expected.to contain_exactly(api_test, browser_test) }
+  end
+
+  describe '#backup' do
+    subject(:backup) { synthetics.backup }
+
+    let(:apifile) { instance_double(File) }
+    let(:browserfile) { instance_double(File) }
+
+    before do
+      allow(File).to receive(:open).with(synthetics.filename('abc-123-def'), 'w').and_return(apifile)
+      allow(File).to receive(:open).with(synthetics.filename('456-ghi-789'), 'w').and_return(browserfile)
+      allow(apifile).to receive(:write)
+      allow(apifile).to receive(:close)
+      allow(browserfile).to receive(:write)
+      allow(browserfile).to receive(:close)
+    end
+
+    it 'is expected to write the API test' do
+      backup
+      expect(apifile).to have_received(:write).with(::JSON.pretty_generate(api_test))
+    end
+
+    it 'is expected to write the browser test' do
+      backup
+      expect(browserfile).to have_received(:write).with(::JSON.pretty_generate(browser_test))
+    end
+  end
+
+  describe '#filename' do
+    subject { synthetics.filename('abc-123-def') }
+
+    it { is_expected.to eq("#{tempdir}/synthetics/abc-123-def.json") }
+  end
+
+  describe '#get_by_id' do
+    context 'when the type is api' do
+      subject { synthetics.get_by_id('abc-123-def') }
+
+      it { is_expected.to eq api_test }
+    end
+
+    context 'when the type is browser' do
+      subject { synthetics.get_by_id('456-ghi-789') }
+
+      it { is_expected.to eq browser_test }
+    end
+  end
+
+  describe '#diff' do # TODO: migrate to core_spec.rb, since #diff is not defined here.
+    subject { synthetics.diff('abc-123-def') }
+
+    before do
+      synthetics.write_file(synthetics.dump(api_test), synthetics.filename('abc-123-def'))
+    end
+
+    context 'when the test is identical' do
+      it { is_expected.to be_empty }
+    end
+
+    context 'when the remote is not found' do
+      subject(:invalid_diff) { synthetics.diff('invalid-id') }
+
+      before do
+        synthetics.write_file(synthetics.dump({ 'name' => 'invalid-diff' }), synthetics.filename('invalid-id'))
+      end
+
+      it {
+        expect(invalid_diff).to eq(%(---- {}\n+---\n+name: invalid-diff))
+      }
+    end
+
+    context 'when there is a local update' do
+      before do
+        different_test = api_test.dup
+        different_test['message'] = 'Different message'
+        synthetics.write_file(synthetics.dump(different_test), synthetics.filename('abc-123-def'))
+      end
+
+      it { is_expected.to include(%(-message: 'TEST: This is a test'\n+message: Different message)) }
+    end
+  end
+
+  describe '#create' do
+    context 'when the type is api' do
+      subject(:create) { synthetics.create({ 'type' => 'api' }) }
+
+      before do
+        stubs.post('/api/v1/synthetics/tests/api') { respond_with200({ 'public_id' => 'api-create-abc' }) }
+      end
+
+      it { is_expected.to eq({ 'public_id' => 'api-create-abc' }) }
+    end
+
+    context 'when the type is browser' do
+      subject(:create) { synthetics.create({ 'type' => 'browser' }) }
+
+      before do
+        stubs.post('/api/v1/synthetics/tests/browser') { respond_with200({ 'public_id' => 'browser-create-abc' }) }
+      end
+
+      it { is_expected.to eq({ 'public_id' => 'browser-create-abc' }) }
+    end
+  end
+
+  describe '#update' do
+    context 'when the type is api' do
+      subject(:update) { synthetics.update('api-update-abc', { 'type' => 'api' }) }
+
+      before do
+        stubs.put('/api/v1/synthetics/tests/api/api-update-abc') { respond_with200({ 'public_id' => 'api-update-abc' }) }
+      end
+
+      it { is_expected.to eq({ 'public_id' => 'api-update-abc' }) }
+    end
+
+    context 'when the type is browser' do
+      subject(:update) { synthetics.update('browser-update-abc', { 'type' => 'browser' }) }
+
+      before do
+        stubs.put('/api/v1/synthetics/tests/browser/browser-update-abc') { respond_with200({ 'public_id' => 'browser-update-abc' }) }
+      end
+
+      it { is_expected.to eq({ 'public_id' => 'browser-update-abc' }) }
+    end
+  end
+
+  describe '#restore' do
+    context 'when the id exists' do
+      subject { synthetics.restore('abc-123-def') }
+
+      before do
+        synthetics.write_file(synthetics.dump({ 'name' => 'restore-valid-id', 'type' => 'api' }), synthetics.filename('abc-123-def'))
+        stubs.put('/api/v1/synthetics/tests/api/abc-123-def') { respond_with200({ 'public_id' => 'abc-123-def', 'type' => 'api' }) }
+      end
+
+      it { is_expected.to eq({ 'public_id' => 'abc-123-def', 'type' => 'api' }) }
+    end
+
+    context 'when the id does not exist' do
+      subject(:restore) { synthetics.restore('restore-invalid-id') }
+
+      before do
+        synthetics.write_file(synthetics.dump({ 'name' => 'restore-invalid-id', 'type' => 'api' }), synthetics.filename('restore-invalid-id'))
+        stubs.put('/api/v1/synthetics/tests/api/restore-invalid-id') { [404, {}, ''] }
+        stubs.post('/api/v1/synthetics/tests/api') { respond_with200({ 'public_id' => 'restore-valid-id' }) }
+        allow(synthetics).to receive(:create).and_call_original
+        allow(synthetics).to receive(:all).and_return([api_test, browser_test, { 'public_id' => 'restore-valid-id', 'type' => 'api' }])
+      end
+
+      it { is_expected.to eq({ 'type' => 'api' }) }
+
+      it 'calls create with the contents of the original file' do
+        restore
+        expect(synthetics).to have_received(:create).with({ 'name' => 'restore-invalid-id', 'type' => 'api' })
+      end
+
+      it 'deletes the original file' do
+        restore
+        expect(File.exist?(synthetics.filename('restore-invalid-id'))).to be false
+      end
+
+      it 'creates a new file with the restored contents' do
+        restore
+        expect(File.exist?(synthetics.filename('restore-valid-id'))).to be true
+      end
+    end
+  end
+end

data/spec/datadog_backup_bin_spec.rb

@@ -3,20 +3,15 @@
 require 'open3'
 require 'timeout'
 
-describe 'bin/datadog_backup' do
+describe 'bin/datadog_backup' do # rubocop:disable RSpec/DescribeClass
   # Contract Or[nil,String] => self
-  def run_bin(args = '', input = nil)
+  def run_bin(env = {}, args = '')
     status = nil
     output = ''
     cmd = "bin/datadog_backup #{args}"
-    Open3.popen2e(cmd) do |i, oe, t|
+    Open3.popen2e(env, cmd) do |_i, oe, t|
       pid = t.pid
 
-      if input
-        i.puts input
-        i.close
-      end
-
       Timeout.timeout(4.0) do
         oe.each do |v|
           output += v
@@ -43,16 +38,23 @@ describe 'bin/datadog_backup' do
 
   required_vars.map do |v|
     it "dies unless given ENV[#{v}]" do
-      stub_const('ENV', env.dup.tap { |h| h.delete(v) })
-      _, status = run_bin('backup')
+      myenv = env.dup.tap { |h| h.delete(v) }
+      _, status = run_bin(myenv, 'backup')
       expect(status).not_to be_success
     end
   end
 
-  it 'supplies help' do
-    stub_const('ENV', env)
-    out_err, status = run_bin('--help')
-    expect(out_err).to match(/Usage: DD_API_KEY=/)
-    expect(status).to be_success
+  describe 'help' do
+    subject(:bin) { run_bin(env, '--help') }
+
+    it 'prints usage' do
+      out_err, _status = bin
+      expect(out_err).to match(/Usage: DD_API_KEY=/)
+    end
+
+    it 'exits cleanly' do
+      _out_err, status = bin
+      expect(status).to be_success
+    end
   end
 end

data/spec/spec_helper.rb

@@ -11,8 +11,6 @@ $stdout = File.new('/dev/null', 'w+')
 require 'tmpdir'
 require 'datadog_backup'
 
-
-
 SPEC_ROOT = __dir__
 WORK_ROOT = File.expand_path(File.join(SPEC_ROOT, '..'))
 
@@ -38,3 +36,7 @@ RSpec.configure do |config|
 
   Kernel.srand config.seed
 end
+
+def respond_with200(body)
+  [200, {}, body]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datadog_backup
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Kamran Farhadi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-25 00:00:00.000000000 Z
+date: 2022-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -110,7 +110,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -124,7 +124,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -138,7 +138,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -230,6 +230,7 @@ files:
 - lib/datadog_backup/local_filesystem.rb
 - lib/datadog_backup/monitors.rb
 - lib/datadog_backup/options.rb
+- lib/datadog_backup/synthetics.rb
 - lib/datadog_backup/thread_pool.rb
 - lib/datadog_backup/version.rb
 - release.config.js
@@ -239,13 +240,14 @@ files:
 - spec/datadog_backup/deprecations_spec.rb
 - spec/datadog_backup/local_filesystem_spec.rb
 - spec/datadog_backup/monitors_spec.rb
+- spec/datadog_backup/synthetics_spec.rb
 - spec/datadog_backup_bin_spec.rb
-- spec/datadog_backup_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/scribd/datadog_backup
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -265,13 +267,4 @@ rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A utility to backup and restore Datadog accounts
-test_files:
-- spec/datadog_backup/cli_spec.rb
-- spec/datadog_backup/core_spec.rb
-- spec/datadog_backup/dashboards_spec.rb
-- spec/datadog_backup/deprecations_spec.rb
-- spec/datadog_backup/local_filesystem_spec.rb
-- spec/datadog_backup/monitors_spec.rb
-- spec/datadog_backup_bin_spec.rb
-- spec/datadog_backup_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/spec/datadog_backup_spec.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe DatadogBackup do
-end