datadog_backup 0.10.2 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54c83b8ce7b212ad43f91a1619363eb683b58cbf7089a24f05b56a5a6a72d250
-  data.tar.gz: 82986e61ff8d93fed519d03c6b38095cce0c97f0981274bb904d94f7b762e056
+  metadata.gz: 5833879f7fbadabad6111eae29c4e487e0d51a0b0802dcd61124985bae70cd23
+  data.tar.gz: 5fdc04d6d1bf28671a4a2000a20c6f1513cbf27f406def181550d956cd270d48
 SHA512:
-  metadata.gz: ec5087654fd806a8cb562912d460dfbdf7c9e1bdb9d75728ce310b4c0b20ba690b7ccb42584c1c28dc4b5db6ba49cfe46d6cb64ad623e6dfb8939ad07dfed56c
-  data.tar.gz: 072762f43d59b7727baccbff8a7273a84ab0b0e1fe0fbd1787486d6b1b08faad9b492b39d68a83be90637a09a6f2bbc436f386775b9da4751308253b0ff6bbc8
+  metadata.gz: 9cc3623d68ec1e5c5872bda3d2e341c9e5d2b1bb954e16d08a2f4d289adb01751f0b7f3f2b0549bfba2fbf91d5ab86c233b59c74f2124642c4cd52b0074a1824
+  data.tar.gz: 9ef0f647d84441c750a65a9cf18130fe89daad15af18ad0e07d61b74caf13ba160388551b4908609bf95a6113f3f39de854b5347becad449fcef0df70782fee2

data/.gitignore

@@ -117,3 +117,5 @@ Gemfile.lock
 
 spec/helpers/failures.txt
 backup/
+
+.envrc

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [0.10.3](https://github.com/scribd/datadog_backup/compare/v0.10.2...v0.10.3) (2020-12-11)
+
+
+### Performance Improvements
+
+* coerce patch release ([bc86649](https://github.com/scribd/datadog_backup/commit/bc86649b874cd5be1da2f6bc0d1b1ecd0728676c))
+
 ## [0.10.2](https://github.com/scribd/datadog_backup/compare/v0.10.1...v0.10.2) (2020-11-03)
 
 

data/Guardfile

@@ -17,7 +17,7 @@
 #
 # and, you'll have to watch "config/Guardfile" instead of "Guardfile"
 
-# Note: The cmd option is now required due to the increasing number of ways
+# NOTE: The cmd option is now required due to the increasing number of ways
 #       rspec may be run, below are examples of the most common uses.
 #  * bundler: 'bundle exec rspec'
 #  * bundler binstubs: 'bin/rspec'

data/example/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-gem 'datadog_backup', :source => 'https://scribd.jfrog.io/artifactory/gems-local'
+gem 'datadog_backup'

data/lib/datadog_backup/cli.rb

@@ -91,7 +91,7 @@ module DatadogBackup
     end
 
     def matching_resource_instance(klass)
-      resource_instances.select { |resource_instance| resource_instance.class == klass }.first
+      resource_instances.select { |resource_instance| resource_instance.instance_of?(klass) }.first
     end
 
     def resource_instances
@@ -117,7 +117,7 @@ module DatadogBackup
           exit
         when 'r'
           puts "Restoring #{id} to Datadog."
-          definitive_resource_instance(id).update_with_200(id, definitive_resource_instance(id).load_from_file_by_id(id))
+          definitive_resource_instance(id).update(id, definitive_resource_instance(id).load_from_file_by_id(id))
         when 'd'
           puts "Downloading #{id} from Datadog."
           definitive_resource_instance(id).get_and_write_file(id)

data/lib/datadog_backup/core.rb

@@ -24,55 +24,48 @@ module DatadogBackup
       raise 'subclass is expected to implement #backup'
     end
 
-    # Calls out to Datadog and checks for a '200' response
-    def client_with_200(method, *id)
-      max_retries = 6
-      retries ||= 0
-
-      response = client.send(method, *id)
-
-      # logger.debug response
-      raise "Method #{method} failed with error #{response}" unless response[0] == '200'
-
-      response[1]
-    rescue ::Net::OpenTimeout => e
-      if (retries += 1) <= max_retries
-        sleep(0.1 * retries**5) # 0.1, 3.2, 24.3, 102.4 seconds per retry
-        retry
-      else
-        raise "Method #{method} failed with error #{e.message}"
-      end
-    end
-
     # Returns the diffy diff.
     # Optionally, supply an array of keys to remove from comparison
-    def diff(id, banlist = [])
-      current = except(get_by_id(id), banlist).deep_sort.to_yaml
-      filesystem = except(load_from_file_by_id(id), banlist).deep_sort.to_yaml
+    def diff(id)
+      current = except(get_by_id(id)).deep_sort.to_yaml
+      filesystem = except(load_from_file_by_id(id)).deep_sort.to_yaml
       result = ::Diffy::Diff.new(current, filesystem, include_plus_and_minus_in_html: true).to_s(diff_format)
       logger.debug("Compared ID #{id} and found #{result}")
       result
     end
 
     # Returns a hash with banlist elements removed
-    def except(hash, banlist)
+    def except(hash)
       hash.tap do # tap returns self
-        banlist.each do |key|
+        @banlist.each do |key|
           hash.delete(key) # delete returns the value at the deleted key, hence the tap wrapper
         end
       end
     end
 
+    def get(id)
+      with_200 do
+        api_service.request(Net::HTTP::Get, "/api/#{api_version}/#{api_resource_name}/#{id}", nil, nil, false)
+      end
+    end
+
+    def get_all
+      with_200 do
+        api_service.request(Net::HTTP::Get, "/api/#{api_version}/#{api_resource_name}", nil, nil, false)
+      end
+    end
+
     def get_and_write_file(id)
       write_file(dump(get_by_id(id)), filename(id))
     end
 
-    def get_by_id(_id)
-      raise 'subclass is expected to implement #get_by_id(id)'
+    def get_by_id(id)
+      except(get(id))
     end
 
     def initialize(options)
       @options = options
+      @banlist = []
       ::FileUtils.mkdir_p(mydir)
     end
 
@@ -80,25 +73,20 @@ module DatadogBackup
       self.class.to_s.split(':').last.downcase
     end
 
-    def restore
-      raise 'subclass is expected to implement #restore'
-    end
-
+    # Calls out to Datadog and checks for a '200' response
     def update(id, body)
-      api_service.request(Net::HTTP::Put, "/api/#{api_version}/#{api_resource_name}/#{id}", nil, body, true)
+      with_200 do
+        api_service.request(Net::HTTP::Put, "/api/#{api_version}/#{api_resource_name}/#{id}", nil, body, true)
+      end
+      logger.warn 'Successfully restored to datadog.'
     end
 
-    # Calls out to Datadog and checks for a '200' response
-    def update_with_200(id, body)
+    def with_200
       max_retries = 6
       retries ||= 0
 
-      response = update(id, body)
-
-      # logger.debug response
-      raise "Update failed with error #{response}" unless response[0] == '200'
-
-      logger.warn "Successfully restored #{id} to datadog."
+      response = yield
+      raise "Request failed with error #{response}" unless response[0] == '200'
 
       response[1]
     rescue ::Net::OpenTimeout => e
@@ -106,8 +94,9 @@ module DatadogBackup
         sleep(0.1 * retries**5) # 0.1, 3.2, 24.3, 102.4 seconds per retry
         retry
       else
-        raise "Update failed with error #{e.message}"
+        raise "Request failed with error #{e.message}"
       end
     end
+
   end
 end

data/lib/datadog_backup/dashboards.rb

@@ -2,10 +2,8 @@
 
 module DatadogBackup
   class Dashboards < Core
-    BANLIST = %w[modified_at url]
-
     def all_boards
-      client_with_200(:get_all_boards).fetch('dashboards')
+      get_all.fetch('dashboards')
     end
 
     def api_service
@@ -37,14 +35,9 @@ module DatadogBackup
       Concurrent::Promises.zip(*futures).value!
     end
 
-    def diff(id)
-      super(id, BANLIST)
-    end
-
-    def get_by_id(id)
-      except(client_with_200(:get_board, id), BANLIST)
+    def initialize(options)
+      super(options)
+      @banlist = %w[modified_at url].freeze
     end
-
-    def restore!; end
   end
 end

data/lib/datadog_backup/local_filesystem.rb

@@ -31,9 +31,10 @@ module DatadogBackup
     end
 
     def dump(object)
-      if output_format == :json
+      case output_format
+      when :json
         JSON.pretty_generate(object.deep_sort)
-      elsif output_format == :yaml
+      when :yaml
         YAML.dump(object.deep_sort)
       else
         raise 'invalid output_format specified or not specified'
@@ -45,7 +46,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)
@@ -53,9 +54,10 @@ module DatadogBackup
     end
 
     def load_from_file(string, output_format)
-      if output_format == :json
+      case output_format
+      when :json
         JSON.parse(string)
-      elsif output_format == :yaml
+      when :yaml
         YAML.safe_load(string)
       else
         raise 'invalid output_format specified or not specified'

data/lib/datadog_backup/monitors.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
 module DatadogBackup
-  class Monitors < Core
-    API_SERVICE_NAME = :@monitor_svc
-    BANLIST = %w[overall_state overall_state_modified matching_downtimes modified]
-
+  class Monitors < Core    
     def all_monitors
-      @all_monitors ||= client_with_200(:get_all_monitors)
+      @all_monitors ||= get_all
     end
 
     def api_service
@@ -29,14 +26,13 @@ module DatadogBackup
       end
     end
 
-    def diff(id)
-      super(id, BANLIST)
-    end
-
     def get_by_id(id)
-      except(all_monitors.select { |monitor| monitor['id'].to_s == id.to_s }.first, BANLIST)
+      except(all_monitors.select { |monitor| monitor['id'].to_s == id.to_s }.first)
     end
 
-    def restore!; end
+    def initialize(options)
+      super(options)
+      @banlist = %w[overall_state overall_state_modified matching_downtimes modified].freeze
+    end
   end
 end

data/lib/datadog_backup/thread_pool.rb

@@ -11,7 +11,7 @@ module DatadogBackup
 
     def self.watcher(logger)
       Thread.new(TPOOL) do |pool|
-        while pool.queue_length > 0
+        while pool.queue_length.positive?
           sleep 2
           logger.info("#{pool.queue_length} tasks remaining for execution.")
         end

data/lib/datadog_backup/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DatadogBackup
-  VERSION = '0.10.2'
+  VERSION = '0.10.3'
 end

data/spec/datadog_backup/cli_spec.rb

@@ -3,6 +3,7 @@
 require 'spec_helper'
 
 describe DatadogBackup::Cli do
+  let(:api_service_double) { double(Dogapi::APIService) }
   let(:client_double) { double }
   let(:tempdir) { Dir.mktmpdir }
   let(:options) do
@@ -43,8 +44,10 @@ describe DatadogBackup::Cli do
         dashboards.write_file('{"text": "diff"}', "#{tempdir}/dashboards/alsostillthere.json")
         dashboards.write_file('{"text": "diff"}', "#{tempdir}/dashboards/deleted.json")
 
-        allow(client_double).to receive(:get_all_boards).and_return(all_boards)
-        allow(client_double).to receive(:get_board).and_return(['200', {}])
+        allow(client_double).to receive(:instance_variable_get).with(:@dashboard_service).and_return(api_service_double)
+        allow(api_service_double).to receive(:request).with(Net::HTTP::Get, "/api/v1/dashboard", nil, nil, false).and_return(all_boards)
+        allow(api_service_double).to receive(:request).with(Net::HTTP::Get, "/api/v1/dashboard/stillthere", nil, nil, false).and_return(['200', {}])
+        allow(api_service_double).to receive(:request).with(Net::HTTP::Get, "/api/v1/dashboard/alsostillthere", nil, nil, false).and_return(['200', {}])
       end
 
       it 'deletes the file locally as well' do
@@ -83,17 +86,16 @@ describe DatadogBackup::Cli do
 
     example 'starts interactive restore' do
       allow($stdin).to receive(:gets).and_return('q')
-      begin
-        expect { subject }.to(
-          output(/\(r\)estore to Datadog, overwrite local changes and \(d\)ownload, \(s\)kip, or \(q\)uit\?/).to_stdout
-          .and(raise_error(SystemExit))
-        )
-      end
+
+      expect { subject }.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_200).with('diffs1', { 'text' => 'diff' })
+      expect(dashboards).to receive(:update).with('diffs1', { 'text' => 'diff' })
       subject
     end
     example 'download' do

data/spec/datadog_backup/core_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DatadogBackup::Core do
@@ -22,21 +24,15 @@ describe DatadogBackup::Core do
     it { is_expected.to eq client_double }
   end
 
-  describe '#client_with_200' do
-    subject { core.client_with_200(:get_all_boards) }
-
+  describe '#with_200' do
     context 'with 200' do
-      before(:example) do
-        allow(client_double).to receive(:get_all_boards).and_return(['200', { foo: :bar }])
-      end
+      subject { core.with_200 {['200', { foo: :bar }]} }
 
       it { is_expected.to eq({ foo: :bar }) }
     end
 
     context 'with not 200' do
-      before(:example) do
-        allow(client_double).to receive(:get_all_boards).and_return(['401', {}])
-      end
+      subject { core.with_200 {['400', "Error message"]} }
 
       it 'raises an error' do
         expect { subject }.to raise_error(RuntimeError)
@@ -50,34 +46,21 @@ describe DatadogBackup::Core do
       core.write_file('{"text": "diff2", "extra": "diff2"}', "#{tempdir}/core/diff.json")
     end
 
-    context 'without banlist' do
-      subject { core.diff('diff') }
-      it {
-        is_expected.to eq <<~EOF
-           ---
-          -extra: diff1
-          -text: diff1
-          +extra: diff2
-          +text: diff2
-        EOF
-      }
-    end
-
-    context 'with banlist' do
-      subject { core.diff('diff', ['extra']) }
-      it {
-        is_expected.to eq <<~EOF
-           ---
-          -text: diff1
-          +text: diff2
-        EOF
-      }
-    end
+    subject { core.diff('diff') }
+    it {
+      is_expected.to eq <<~EOF
+         ---
+        -extra: diff1
+        -text: diff1
+        +extra: diff2
+        +text: diff2
+      EOF
+    }
   end
 
   describe '#except' do
-    subject { core.except({ a: :b, b: :c }, [:b]) }
-    it { is_expected.to eq({ a: :b }) }
+    subject { core.except({ a: :b, b: :c }) }
+    it { is_expected.to eq({ a: :b, b: :c }) }
   end
 
   describe '#initialize' do
@@ -94,7 +77,7 @@ describe DatadogBackup::Core do
   end
 
   describe '#update' do
-    subject { core.update_with_200('abc-123-def', '{"a": "b"}') }
+    subject { core.update('abc-123-def', '{"a": "b"}') }
     example 'it calls Dogapi::APIService.request' do
       stub_const('Dogapi::APIService::API_VERSION', 'v1')
       allow(core).to receive(:api_service).and_return(api_service_double)

data/spec/datadog_backup/dashboards_spec.rb

@@ -3,6 +3,7 @@
 require 'spec_helper'
 
 describe DatadogBackup::Dashboards do
+  let(:api_service_double) { double(Dogapi::APIService) }
   let(:client_double) { double }
   let(:tempdir) { Dir.mktmpdir }
   let(:dashboards) do
@@ -59,8 +60,9 @@ describe DatadogBackup::Dashboards do
     }
   end
   before(:example) do
-    allow(client_double).to receive(:get_all_boards).and_return(all_boards)
-    allow(client_double).to receive(:get_board).and_return(example_dashboard)
+    allow(client_double).to receive(:instance_variable_get).with(:@dashboard_service).and_return(api_service_double)
+    allow(api_service_double).to receive(:request).with(Net::HTTP::Get, "/api/v1/dashboard", nil, nil, false).and_return(all_boards)
+    allow(api_service_double).to receive(:request).with(Net::HTTP::Get, "/api/v1/dashboard/abc-123-def", nil, nil, false).and_return(example_dashboard)
   end
 
   describe '#backup' do
@@ -79,22 +81,34 @@ describe DatadogBackup::Dashboards do
   describe '#all_boards' do
     subject { dashboards.all_boards }
 
-    it 'calls get_all_boards' do
-      subject
-      expect(client_double).to have_received(:get_all_boards)
-    end
-
     it { is_expected.to eq [dashboard_description] }
   end
 
   describe '#diff' do
     it 'calls the api only once' do
       dashboards.write_file('{"a":"b"}', dashboards.filename('abc-123-def'))
-      dashboards.diff('abc-123-def')
-      expect(client_double).to have_received(:get_board).exactly(1).times
+      expect(dashboards.diff('abc-123-def')).to eq(<<~EOF
+         ---
+        -description: example dashboard
+        -graphs:
+        -- definition:
+        -    requests:
+        -    - q: min:foo.bar{a:b}
+        -      stacked: false
+        -    viz: timeseries
+        -  title: example graph
+        -title: example dashboard
+        +a: b
+      EOF
+    )
     end
   end
 
+  describe '#except' do
+    subject { dashboards.except({ :a => :b, 'modified_at' => :c, 'url' => :d }) }
+    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 }

data/spec/datadog_backup/monitors_spec.rb

@@ -3,6 +3,7 @@
 require 'spec_helper'
 
 describe DatadogBackup::Monitors do
+  let(:api_service_double) { double(Dogapi::APIService) }
   let(:client_double) { double }
   let(:tempdir) { Dir.mktmpdir }
   let(:monitors) do
@@ -47,19 +48,15 @@ describe DatadogBackup::Monitors do
       monitor_description
     ]
   end
+
   before(:example) do
-    allow(client_double).to receive(:get_all_monitors).and_return(all_monitors)
-    allow(client_double).to receive(:get_monitor).and_return(example_monitor)
+    allow(client_double).to receive(:instance_variable_get).with(:@monitor_svc).and_return(api_service_double)
+    allow(api_service_double).to receive(:request).with(Net::HTTP::Get, "/api/v1/monitor", nil, nil, false).and_return(all_monitors)
+    allow(api_service_double).to receive(:request).with(Net::HTTP::Get, "/api/v1/dashboard/123455", nil, nil, false).and_return(example_monitor)
   end
 
   describe '#all_monitors' do
     subject { monitors.all_monitors }
-
-    it 'calls get_all_monitors' do
-      subject
-      expect(client_double).to have_received(:get_all_monitors)
-    end
-
     it { is_expected.to eq [monitor_description] }
   end
 
@@ -76,10 +73,10 @@ describe DatadogBackup::Monitors do
     end
   end
 
-  describe '#diff' do
+  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))
-      allow(client_double).to receive(:get_all_monitors).and_return(
+      allow(api_service_double).to receive(:request).and_return(
         [
           '200',
           [
@@ -88,8 +85,8 @@ describe DatadogBackup::Monitors do
               'message' => 'foo',
               'id' => 123_455,
               'name' => 'foo',
-              'overall_state' => 'NO DATA',
-              'overall_state_modified' => '2020-07-27T22:55:55+00:00'
+              'overall_state' => 'ZZZZZZZZZZZZZZZZZZZZZZZZZZZ',
+              'overall_state_modified' => '9999-07-27T22:55:55+00:00'
             }
           ]
         ]

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
 
 require 'datadog_backup'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datadog_backup
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.3
 platform: ruby
 authors:
 - Kamran Farhadi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2020-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print