datadog_backup 3.0.0.alpha.1 → 3.1.0

data/lib/datadog_backup/dashboards.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
 module DatadogBackup
+  # Dashboards specific overrides for backup and restore.
   class Dashboards < Core
+    def all
+      get_all.fetch('dashboards')
+    end
 
     def api_version
       'v1'
@@ -11,12 +15,15 @@ module DatadogBackup
       'dashboard'
     end
 
+    def id_keyname
+      'id'
+    end
+
     def backup
       LOGGER.info("Starting diffs on #{::DatadogBackup::ThreadPool::TPOOL.max_length} threads")
-
-      futures = all_dashboards.map do |board|
-        Concurrent::Promises.future_on(::DatadogBackup::ThreadPool::TPOOL, board) do |board|
-          id = board['id']
+      futures = all.map do |dashboard|
+        Concurrent::Promises.future_on(::DatadogBackup::ThreadPool::TPOOL, dashboard) do |board|
+          id = board[id_keyname]
           get_and_write_file(id)
         end
       end
@@ -27,10 +34,6 @@ module DatadogBackup
       Concurrent::Promises.zip(*futures).value!
     end
 
-    def all_dashboards
-      get_all.fetch('dashboards')
-    end
-
     def initialize(options)
       super(options)
       @banlist = %w[modified_at url].freeze

data/lib/datadog_backup/deprecations.rb

@@ -1,11 +1,10 @@
-
+# frozen_string_literal: true
 
 module DatadogBackup
+  # Notify the user if they are using deprecated features.
   module Deprecations
     def self.check
-      if RUBY_VERSION < '2.7'
-        LOGGER.warn "ruby-#{RUBY_VERSION} is deprecated. Ruby 2.7 or higher will be required to use this gem after datadog_backup@v3"
-      end
+      LOGGER.warn "ruby-#{RUBY_VERSION} is deprecated. Ruby 2.7 or higher will be required to use this gem after datadog_backup@v3" if RUBY_VERSION < '2.7'
     end
   end
-end
+end

data/lib/datadog_backup/local_filesystem.rb

@@ -6,11 +6,10 @@ require 'yaml'
 require 'deepsort'
 
 module DatadogBackup
+  ##
+  # Meant to be mixed into DatadogBackup::Core
+  # Relies on @options[:backup_dir] and @options[:output_format]
   module LocalFilesystem
-    ##
-    # Meant to be mixed into DatadogBackup::Core
-    # Relies on @options[:backup_dir] and @options[:output_format]
-
     def all_files
       ::Dir.glob(::File.join(backup_dir, '**', '*')).select { |f| ::File.file?(f) }
     end
@@ -46,7 +45,7 @@ module DatadogBackup
     end
 
     def file_type(filepath)
-      ::File.extname(filepath).strip.downcase[1..-1].to_sym
+      ::File.extname(filepath).strip.downcase[1..].to_sym
     end
 
     def find_file_by_id(id)

data/lib/datadog_backup/monitors.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 module DatadogBackup
+  # Monitor specific overrides for backup and restore.
   class Monitors < Core
-    def all_monitors
-      @all_monitors ||= get_all
+    def all
+      get_all
     end
 
     def api_version
@@ -15,14 +16,14 @@ module DatadogBackup
     end
 
     def backup
-      all_monitors.map do |monitor|
+      all.map do |monitor|
         id = monitor['id']
         write_file(dump(get_by_id(id)), filename(id))
       end
     end
 
     def get_by_id(id)
-      monitor = all_monitors.select { |monitor| monitor['id'].to_s == id.to_s }.first
+      monitor = all.select { |m| m['id'].to_s == id.to_s }.first
       monitor.nil? ? {} : except(monitor)
     end
 

data/lib/datadog_backup/options.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module DatadogBackup
+  # Describes what the user wants to see done.
   module Options
     def action
       @options[:action]

data/lib/datadog_backup/synthetics.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module DatadogBackup
+  # Synthetic specific overrides for backup and restore.
+  class Synthetics < Core
+    def all
+      get_all.fetch('tests')
+    end
+
+    def api_version
+      'v1'
+    end
+
+    def api_resource_name(body = nil)
+      return 'synthetics/tests' if body.nil?
+      return 'synthetics/tests' if body['type'].nil?
+      return 'synthetics/tests/browser' if body['type'].to_s == 'browser'
+      return 'synthetics/tests/api' if body['type'].to_s == 'api'
+
+      raise "Unknown type #{body['type']}"
+    end
+
+    def id_keyname
+      'public_id'
+    end
+
+    def backup
+      all.map do |synthetic|
+        id = synthetic[id_keyname]
+        get_and_write_file(id)
+      end
+    end
+
+    def get_by_id(id)
+      synthetic = all.select { |s| s[id_keyname].to_s == id.to_s }.first
+      synthetic.nil? ? {} : except(synthetic)
+    end
+
+    def initialize(options)
+      super(options)
+      @banlist = %w[creator created_at modified_at monitor_id public_id].freeze
+    end
+
+    def create(body)
+      create_api_resource_name = api_resource_name(body)
+      headers = {}
+      response = api_service.post("/api/#{api_version}/#{create_api_resource_name}", body, headers)
+      resbody = body_with_2xx(response)
+      LOGGER.warn "Successfully created #{resbody.fetch(id_keyname)} in datadog."
+      LOGGER.info 'Invalidating cache'
+      @get_all = nil
+      resbody
+    end
+
+    def update(id, body)
+      update_api_resource_name = api_resource_name(body)
+      headers = {}
+      response = api_service.put("/api/#{api_version}/#{update_api_resource_name}/#{id}", body, headers)
+      resbody = body_with_2xx(response)
+      LOGGER.warn "Successfully restored #{id} to datadog."
+      LOGGER.info 'Invalidating cache'
+      @get_all = nil
+      resbody
+    end
+  end
+end

data/lib/datadog_backup/thread_pool.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module DatadogBackup
+  # Used by CLI and Dashboards to size thread pool according to available CPU cores.
   module ThreadPool
     TPOOL = ::Concurrent::ThreadPoolExecutor.new(
       min_threads: [2, Concurrent.processor_count].max,

data/lib/datadog_backup/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DatadogBackup
-  VERSION = '3.0.0.alpha.1'
+  VERSION = '3.1.0'
 end

data/lib/datadog_backup.rb

@@ -2,21 +2,18 @@
 
 require 'concurrent'
 
-require 'pry' #TODO: remove this
-require 'pry-byebug' #TODO: remove this
-
 require_relative 'datadog_backup/local_filesystem'
 require_relative 'datadog_backup/options'
 require_relative 'datadog_backup/cli'
 require_relative 'datadog_backup/core'
 require_relative 'datadog_backup/dashboards'
 require_relative 'datadog_backup/monitors'
+require_relative 'datadog_backup/synthetics'
 require_relative 'datadog_backup/thread_pool'
 require_relative 'datadog_backup/version'
 require_relative 'datadog_backup/deprecations'
 DatadogBackup::Deprecations.check
 
-
+# DatadogBackup is a gem for backing up and restoring Datadog monitors and dashboards.
 module DatadogBackup
 end
-

data/release.config.js

@@ -1,4 +1,8 @@
 module.exports = {
+  "branches": [
+    '+([0-9])?(.{+([0-9]),x}).x',
+    'main'
+  ],
   "plugins": [
     "@semantic-release/commit-analyzer",
     "@semantic-release/release-notes-generator",
@@ -8,12 +12,6 @@ module.exports = {
         "changelogFile": "CHANGELOG.md"
       }
     ],
-    [
-      "semantic-release-rubygem",
-      {
-        "gemFileDir": "."
-      }
-    ],
     [
       "@semantic-release/git",
       {

data/spec/datadog_backup/cli_spec.rb

@@ -47,8 +47,8 @@ describe DatadogBackup::Cli do
         dashboards.write_file('{"text": "diff"}', "#{tempdir}/dashboards/deleted.json")
 
         stubs.get('/api/v1/dashboard') { all_dashboards }
-        stubs.get('/api/v1/dashboard/stillthere') {[200, {}, {}]}
-        stubs.get('/api/v1/dashboard/alsostillthere') {[200, {}, {}]}
+        stubs.get('/api/v1/dashboard/stillthere') { respond_with200({}) }
+        stubs.get('/api/v1/dashboard/alsostillthere') { respond_with200({}) }
       end
 
       it 'deletes the file locally as well' do
@@ -58,66 +58,81 @@ describe DatadogBackup::Cli do
     end
   end
 
-  describe '#diffs' do
-    subject { cli.diffs }
-
-    before do
-      dashboards.write_file('{"text": "diff"}', "#{tempdir}/dashboards/diffs1.json")
-      dashboards.write_file('{"text": "diff"}', "#{tempdir}/dashboards/diffs2.json")
-      dashboards.write_file('{"text": "diff"}', "#{tempdir}/dashboards/diffs3.json")
-      allow(dashboards).to receive(:get_by_id).and_return({ 'text' => 'diff2' })
-    end
-
-    it {
-      expect(subject).to include(
-        " ---\n id: diffs1\n ---\n-text: diff2\n+text: diff\n",
-        " ---\n id: diffs3\n ---\n-text: diff2\n+text: diff\n",
-        " ---\n id: diffs2\n ---\n-text: diff2\n+text: diff\n"
-      )
-    }
-  end
-
   describe '#restore' do
-    subject { cli.restore }
+    subject(:restore) { cli.restore }
 
     before do
       dashboards.write_file('{"text": "diff"}', "#{tempdir}/dashboards/diffs1.json")
       allow(dashboards).to receive(:get_by_id).and_return({ 'text' => 'diff2' })
+      allow(dashboards).to receive(:write_file)
+      allow(dashboards).to receive(:update)
     end
 
     example 'starts interactive restore' do
       allow($stdin).to receive(:gets).and_return('q')
 
-      expect { subject }.to(
+      expect { restore }.to(
         output(/\(r\)estore to Datadog, overwrite local changes and \(d\)ownload, \(s\)kip, or \(q\)uit\?/).to_stdout
         .and(raise_error(SystemExit))
       )
     end
 
-    example 'restore' do
-      allow($stdin).to receive(:gets).and_return('r')
-      expect(dashboards).to receive(:update).with('diffs1', { 'text' => 'diff' })
-      subject
+    context 'when the user chooses to restore' do
+      before do
+        allow($stdin).to receive(:gets).and_return('r')
+      end
+
+      example 'it restores from disk to server' do
+        restore
+        expect(dashboards).to have_received(:update).with('diffs1', { 'text' => 'diff' })
+      end
     end
 
-    example 'download' do
-      allow($stdin).to receive(:gets).and_return('d')
-      expect(dashboards).to receive(:write_file).with(%({\n  "text": "diff2"\n}), "#{tempdir}/dashboards/diffs1.json")
-      subject
+    context 'when the user chooses to download' do
+      before do
+        allow($stdin).to receive(:gets).and_return('d')
+      end
+
+      example 'it writes from server to disk' do
+        restore
+        expect(dashboards).to have_received(:write_file).with(%({\n  "text": "diff2"\n}), "#{tempdir}/dashboards/diffs1.json")
+      end
     end
 
-    example 'skip' do
-      allow($stdin).to receive(:gets).and_return('s')
-      expect(dashboards).not_to receive(:write_file)
-      expect(dashboards).not_to receive(:update)
-      subject
+    context 'when the user chooses to skip' do
+      before do
+        allow($stdin).to receive(:gets).and_return('s')
+      end
+
+      example 'it does not write to disk' do
+        restore
+        expect(dashboards).not_to have_received(:write_file)
+      end
+
+      example 'it does not update the server' do
+        restore
+        expect(dashboards).not_to have_received(:update)
+      end
     end
 
-    example 'quit' do
-      allow($stdin).to receive(:gets).and_return('q')
-      expect(dashboards).not_to receive(:write_file)
-      expect(dashboards).not_to receive(:update)
-      expect { subject }.to raise_error(SystemExit)
+    context 'when the user chooses to quit' do
+      before do
+        allow($stdin).to receive(:gets).and_return('q')
+      end
+
+      example 'it exits' do
+        expect { restore }.to raise_error(SystemExit)
+      end
+
+      example 'it does not write to disk' do
+        restore
+        expect(dashboards).not_to have_received(:write_file)
+      end
+
+      example 'it does not update the server' do
+        restore
+        expect(dashboards).not_to have_received(:update)
+      end
     end
   end
 end

data/spec/datadog_backup/core_spec.rb

@@ -18,11 +18,8 @@ describe DatadogBackup::Core do
     return core
   end
 
-
-
-
   describe '#diff' do
-    subject { core.diff('diff') }
+    subject(:diff) { core.diff('diff') }
 
     before do
       allow(core).to receive(:get_by_id).and_return({ 'text' => 'diff1', 'extra' => 'diff1' })
@@ -30,13 +27,14 @@ describe DatadogBackup::Core do
     end
 
     it {
-      expect(subject).to eq <<~EOF
+      expect(diff).to eq(<<~EODIFF
          ---
         -extra: diff1
         -text: diff1
         +extra: diff2
         +text: diff2
-      EOF
+      EODIFF
+      .chomp)
     }
   end
 
@@ -47,11 +45,13 @@ describe DatadogBackup::Core do
   end
 
   describe '#initialize' do
-    subject { core }
+    subject(:mycore) { core }
 
     it 'makes the subdirectories' do
-      expect(FileUtils).to receive(:mkdir_p).with("#{tempdir}/core")
-      subject
+      fileutils = class_double(FileUtils).as_stubbed_const
+      allow(fileutils).to receive(:mkdir_p)
+      mycore
+      expect(fileutils).to have_received(:mkdir_p).with("#{tempdir}/core")
     end
   end
 
@@ -62,25 +62,25 @@ describe DatadogBackup::Core do
   end
 
   describe '#create' do
-    subject { core.create({ 'a' => 'b' }) }
+    subject(:create) { core.create({ 'a' => 'b' }) }
 
     example 'it will post /api/v1/dashboard' do
       allow(core).to receive(:api_version).and_return('v1')
       allow(core).to receive(:api_resource_name).and_return('dashboard')
-      stubs.post('/api/v1/dashboard', {'a' => 'b'}) {[200, {},  {'id' => 'whatever-id-abc' }]}
-      subject
+      stubs.post('/api/v1/dashboard', { 'a' => 'b' }) {  respond_with200({ 'id' => 'whatever-id-abc' }) }
+      create
       stubs.verify_stubbed_calls
     end
   end
 
   describe '#update' do
-    subject { core.update('abc-123-def', { 'a' => 'b' }) }
+    subject(:update) { core.update('abc-123-def', { 'a' => 'b' }) }
 
     example 'it puts /api/v1/dashboard' do
       allow(core).to receive(:api_version).and_return('v1')
       allow(core).to receive(:api_resource_name).and_return('dashboard')
-      stubs.put('/api/v1/dashboard/abc-123-def', {'a' => 'b'}) {[200, {},  {'id' => 'whatever-id-abc' }]}
-      subject
+      stubs.put('/api/v1/dashboard/abc-123-def', { 'a' => 'b' }) { respond_with200({ 'id' => 'whatever-id-abc' }) }
+      update
       stubs.verify_stubbed_calls
     end
 
@@ -88,10 +88,11 @@ describe DatadogBackup::Core do
       before do
         allow(core).to receive(:api_version).and_return('v1')
         allow(core).to receive(:api_resource_name).and_return('dashboard')
-        stubs.put('/api/v1/dashboard/abc-123-def', {'a' => 'b'}) {[404, {},  {'id' => 'whatever-id-abc' }]}
+        stubs.put('/api/v1/dashboard/abc-123-def', { 'a' => 'b' }) { [404, {}, { 'id' => 'whatever-id-abc' }] }
       end
+
       it 'raises an error' do
-        expect { subject }.to raise_error(RuntimeError, 'update failed with error 404')
+        expect { update }.to raise_error(RuntimeError, 'update failed with error 404')
       end
     end
   end
@@ -100,35 +101,55 @@ describe DatadogBackup::Core do
     before do
       allow(core).to receive(:api_version).and_return('api-version-string')
       allow(core).to receive(:api_resource_name).and_return('api-resource-name-string')
-      stubs.get('/api/api-version-string/api-resource-name-string/abc-123-def') {[200, {},  {'test'  => 'ok' }]}
-      stubs.get('/api/api-version-string/api-resource-name-string/bad-123-id') {[404, {},  {'error'  => 'blahblah_not_found' }]}
+      stubs.get('/api/api-version-string/api-resource-name-string/abc-123-def') { respond_with200({ 'test' => 'ok' }) }
+      stubs.get('/api/api-version-string/api-resource-name-string/bad-123-id') do
+        [404, {}, { 'error' => 'blahblah_not_found' }]
+      end
       allow(core).to receive(:load_from_file_by_id).and_return({ 'load' => 'ok' })
     end
 
     context 'when id exists' do
-      subject { core.restore('abc-123-def') }
+      subject(:restore) { core.restore('abc-123-def') }
 
       example 'it calls out to update' do
-        expect(core).to receive(:update).with('abc-123-def', { 'load' => 'ok' })
-        subject
+        allow(core).to receive(:update)
+        restore
+        expect(core).to have_received(:update).with('abc-123-def', { 'load' => 'ok' })
       end
     end
 
     context 'when id does not exist on remote' do
-      subject { core.restore('bad-123-id') }
+      subject(:restore_newly) { core.restore('bad-123-id') }
+
+      let(:fileutils) { class_double(FileUtils).as_stubbed_const }
 
       before do
         allow(core).to receive(:load_from_file_by_id).and_return({ 'load' => 'ok' })
-        stubs.put('/api/api-version-string/api-resource-name-string/bad-123-id') {[404, {},  {'error'  => 'id not found' }]}
-        stubs.post('/api/api-version-string/api-resource-name-string', {'load' => 'ok'}) {[200, {},  {'id' => 'my-new-id' }]}
+        stubs.put('/api/api-version-string/api-resource-name-string/bad-123-id') do
+          [404, {}, { 'error' => 'id not found' }]
+        end
+        stubs.post('/api/api-version-string/api-resource-name-string', { 'load' => 'ok' }) do
+          respond_with200({ 'id' => 'my-new-id' })
+        end
+        allow(fileutils).to receive(:rm)
+        allow(core).to receive(:create).with({ 'load' => 'ok' }).and_return({ 'id' => 'my-new-id' })
+        allow(core).to receive(:get_and_write_file)
+        allow(core).to receive(:find_file_by_id).with('bad-123-id').and_return('/path/to/bad-123-id.json')
       end
 
-      example 'it calls out to create then saves the new file and deletes the new file' do
-        expect(core).to receive(:create).with({ 'load' => 'ok' }).and_return({ 'id' => 'my-new-id' })
-        expect(core).to receive(:get_and_write_file).with('my-new-id')
-        allow(core).to receive(:find_file_by_id).with('bad-123-id').and_return('/path/to/bad-123-id.json')
-        expect(FileUtils).to receive(:rm).with('/path/to/bad-123-id.json')
-        subject
+      example 'it calls out to create' do
+        restore_newly
+        expect(core).to have_received(:create).with({ 'load' => 'ok' })
+      end
+
+      example 'it saves the new file' do
+        restore_newly
+        expect(core).to have_received(:get_and_write_file).with('my-new-id')
+      end
+
+      example 'it deletes the old file' do
+        restore_newly
+        expect(fileutils).to have_received(:rm).with('/path/to/bad-123-id.json')
       end
     end
   end

data/spec/datadog_backup/dashboards_spec.rb

@@ -23,24 +23,6 @@ describe DatadogBackup::Dashboards do
       'title' => 'foo'
     }
   end
-  let(:all_dashboards) do
-    [
-      200,
-      {},
-      {
-        'dashboards' => [
-          dashboard_description
-        ]
-      }
-    ]
-  end
-  let(:example_dashboard) do
-    [
-      200,
-      {},
-      board_abc_123_def
-    ]
-  end
   let(:board_abc_123_def) do
     {
       'graphs' => [
@@ -61,6 +43,8 @@ describe DatadogBackup::Dashboards do
       'title' => 'example dashboard'
     }
   end
+  let(:all_dashboards) { respond_with200({ 'dashboards' => [dashboard_description] }) }
+  let(:example_dashboard) { respond_with200(board_abc_123_def) }
 
   before do
     stubs.get('/api/v1/dashboard') { all_dashboards }
@@ -71,25 +55,32 @@ describe DatadogBackup::Dashboards do
     subject { dashboards.backup }
 
     it 'is expected to create a file' do
-      file = double('file')
+      file = instance_double(File)
       allow(File).to receive(:open).with(dashboards.filename('abc-123-def'), 'w').and_return(file)
-      expect(file).to receive(:write).with(::JSON.pretty_generate(board_abc_123_def.deep_sort))
+      allow(file).to receive(:write)
       allow(file).to receive(:close)
 
       dashboards.backup
+      expect(file).to have_received(:write).with(::JSON.pretty_generate(board_abc_123_def.deep_sort))
     end
   end
 
-  describe '#all_dashboards' do
-    subject { dashboards.all_dashboards }
+  describe '#filename' do
+    subject { dashboards.filename('abc-123-def') }
+
+    it { is_expected.to eq("#{tempdir}/dashboards/abc-123-def.json") }
+  end
+
+  describe '#get_by_id' do
+    subject { dashboards.get_by_id('abc-123-def') }
 
-    it { is_expected.to eq [dashboard_description] }
+    it { is_expected.to eq board_abc_123_def }
   end
 
   describe '#diff' do
     it 'calls the api only once' do
       dashboards.write_file('{"a":"b"}', dashboards.filename('abc-123-def'))
-      expect(dashboards.diff('abc-123-def')).to eq(<<~EOF
+      expect(dashboards.diff('abc-123-def')).to eq(<<~EODASH
          ---
         -description: example dashboard
         -graphs:
@@ -101,8 +92,8 @@ describe DatadogBackup::Dashboards do
         -  title: example graph
         -title: example dashboard
         +a: b
-      EOF
-                                                  )
+      EODASH
+      .chomp)
     end
   end
 
@@ -111,10 +102,4 @@ describe DatadogBackup::Dashboards do
 
     it { is_expected.to eq({ a: :b }) }
   end
-
-  describe '#get_by_id' do
-    subject { dashboards.get_by_id('abc-123-def') }
-
-    it { is_expected.to eq board_abc_123_def }
-  end
 end