datadog_backup 3.0.0.alpha.2 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ada6cc077ab1a7145bdbee5db768e9544a50a20f427c49bf86aabfe63ab2b74
-  data.tar.gz: 0e40617381ac33d1b4094cd277303dca2d0ece0372f7f13a3b4161eac304f34c
+  metadata.gz: 332899376b51dd8ad98dda7a3528b7a7c80ca8cbbd2c4bbe9c2cb9976a1c7024
+  data.tar.gz: 68b89a77b5148006b16388c7a93241ca50fcecb6bc4edc09ab36cf34a80d92e8
 SHA512:
-  metadata.gz: 437faae8390ce834b7a20bfcf6f2097f94a8ab93a808aa0c5594e1972e0e8b9497e16838dda7b02f89349b8a41c721e4577ea552cf1b267ea923b016d00f77dc
-  data.tar.gz: 9a96702e3928e1768adc888dc206cdf13e4a7a3adb9b99a385dd487338b52ff62028de96e87220eb487b9959d73e58a1a02d12f125c906b8e62209ad6e65d94d
+  metadata.gz: ab35b9e6a6152cc22ff3de7714ed60f2bca54c056a510d5726e5d33921a0f54d088195bfd7b992494545ccdfa8350e99e097c19155cfde4f7396049aeaad9650
+  data.tar.gz: 4f2f791146658c9a9e4185ef3bda43180a5ef46938dd6b2754aa493bcac9949f19a53f70b972a125ae51ad7b71f6f8c309767d83654e40a4d7d5f4be70e6c39c

data/.github/workflows/rspec_and_release.yml

@@ -25,7 +25,6 @@ jobs:
       run: |
           bundle exec rspec --format documentation --require spec_helper
   release:
-    if: github.event_name == 'push'
     needs: rspec
     runs-on: ubuntu-latest
     env:
@@ -36,7 +35,6 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.7
-        bundler-cache: true
     - name: Zip
       run : |
         zip -r datadog_backup.zip ./*

data/.gitignore

@@ -120,4 +120,6 @@ backup/
 
 .envrc
 
-.vscode
+.vscode
+spec/examples.txt
+

data/.rubocop.yml

@@ -1,78 +1,37 @@
-require: rubocop-rspec
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+require:
+  - rubocop-rspec
 
-Gemspec/DateAssignment: # (new in 1.10)
-  Enabled: true
-Layout/LineEndStringConcatenationIndentation: # (new in 1.18)
-  Enabled: true
-Layout/SpaceBeforeBrackets: # (new in 1.7)
-  Enabled: true
-Lint/AmbiguousAssignment: # (new in 1.7)
-  Enabled: true
-Lint/DeprecatedConstants: # (new in 1.8)
-  Enabled: true
-Lint/DuplicateBranch: # (new in 1.3)
-  Enabled: true
-Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
-  Enabled: true
-Lint/EmptyBlock: # (new in 1.1)
-  Enabled: true
-Lint/EmptyClass: # (new in 1.3)
-  Enabled: true
-Lint/EmptyInPattern: # (new in 1.16)
-  Enabled: true
-Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
-  Enabled: true
-Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
-  Enabled: true
-Lint/NumberedParameterAssignment: # (new in 1.9)
-  Enabled: true
-Lint/OrAssignmentToConstant: # (new in 1.9)
-  Enabled: true
-Lint/RedundantDirGlobSort: # (new in 1.8)
-  Enabled: true
-Lint/SymbolConversion: # (new in 1.9)
-  Enabled: true
-Lint/ToEnumArguments: # (new in 1.1)
-  Enabled: true
-Lint/TripleQuotes: # (new in 1.9)
-  Enabled: true
-Lint/UnexpectedBlockArity: # (new in 1.5)
-  Enabled: true
-Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
-  Enabled: true
-Naming/InclusiveLanguage: # (new in 1.18)
-  Enabled: true
-Style/ArgumentsForwarding: # (new in 1.1)
-  Enabled: true
-Style/CollectionCompact: # (new in 1.2)
-  Enabled: true
-Style/DocumentDynamicEvalDefinition: # (new in 1.1)
-  Enabled: true
-Style/EndlessMethod: # (new in 1.8)
-  Enabled: true
-Style/HashConversion: # (new in 1.10)
-  Enabled: true
-Style/HashExcept: # (new in 1.7)
-  Enabled: true
-Style/IfWithBooleanLiteralBranches: # (new in 1.9)
-  Enabled: true
-Style/InPatternThen: # (new in 1.16)
-  Enabled: true
-Style/MultilineInPatternThen: # (new in 1.16)
-  Enabled: true
-Style/NegatedIfElseCondition: # (new in 1.2)
-  Enabled: true
-Style/NilLambda: # (new in 1.3)
-  Enabled: true
-Style/QuotedSymbols: # (new in 1.16)
-  Enabled: true
-Style/RedundantArgument: # (new in 1.4)
-  Enabled: true
-Style/StringChars: # (new in 1.12)
-  Enabled: true
-Style/SwapValues: # (new in 1.1)
-  Enabled: true
-RSpec/IdenticalEqualityAssertion: # (new in 2.4)
-  Enabled: true
-RSpec/Rails/AvoidSetupHook: # (new in 2.4)
-  Enabled: true
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,42 @@
+## [3.1.1](https://github.com/scribd/datadog_backup/compare/v3.1.0...v3.1.1) (2022-09-01)
+
+
+### Bug Fixes
+
+* catch SystemExit so that rspec can complete ([9eee0e5](https://github.com/scribd/datadog_backup/commit/9eee0e5c5ea857baeafcf3fbc0f1c8f3748b0ca8))
+* specify minimum ruby version in Gemfile ([c7f48f9](https://github.com/scribd/datadog_backup/commit/c7f48f95269a23549e28576434292d4ba1332d59))
+
+
+### Reverts
+
+* Revert "fix: specify minimum ruby version in Gemfile" ([e934ac2](https://github.com/scribd/datadog_backup/commit/e934ac2611c9bb557a181dd2f6f6b2678287773d))
+
+# [3.1.0](https://github.com/scribd/datadog_backup/compare/v3.0.0...v3.1.0) (2022-08-30)
+
+
+### Features
+
+* backup and restore synthetics ([#139](https://github.com/scribd/datadog_backup/issues/139)) ([a46cadc](https://github.com/scribd/datadog_backup/commit/a46cadc7d196dcb0f20bf31d06cde6a13a390835))
+
+# [3.0.0](https://github.com/scribd/datadog_backup/compare/v2.0.2...v3.0.0) (2022-08-25)
+
+
+* feat!: release 3.0 (#136) ([3d23b03](https://github.com/scribd/datadog_backup/commit/3d23b03668e888886f394de2fa4884aa1e3ca287)), closes [#136](https://github.com/scribd/datadog_backup/issues/136)
+
+
+### BREAKING CHANGES
+
+* DATADOG_API_KEY and DATADOG_APP_KEY are no longer the environment variables used to authenticate to Datadog. Instead, set the environment variables DD_API_KEY and DD_APP_KEY.
+* ruby 2.6 is no longer supported. Please upgrade to ruby 2.7 or higher.
+* The options `--ssh` and `--ssshh` are no longer supported. Instead, please use `--quiet` to supress logging. `--debug` remains supported.
+* The environment variable `DATADOG_HOST` is no longer supported. Instead, please use `DD_SITE_URL`.
+
+refactor: The legacy [dogapi-rb ](https://github.com/DataDog/dogapi-rb) gem is replaced with [faraday](https://lostisland.github.io/faraday/).  The [official client library](https://github.com/DataDog/datadog-api-client-ruby) was considered, but was not adopted as I had a hard time grok-ing it.
+
+* chore: permit logging from tests, but only error+
+
+Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net>
+
 # [3.0.0-alpha.2](https://github.com/scribd/datadog_backup/compare/v3.0.0-alpha.1...v3.0.0-alpha.2) (2022-08-25)
 
 

data/README.md

@@ -16,7 +16,7 @@ Additional features may be built out over time.
 ## Breaking Changes
 v3 is a backwards incompatible change.
 
-- [] DATADOG_API_KEY and DATADOG_APP_KEY are no longer the environment variables used to authenticate to Datadog. Instead, set the environment variables DD_API_KEY and DD_APP_KEY.
+- [ ] DATADOG_API_KEY and DATADOG_APP_KEY are no longer the environment variables used to authenticate to Datadog. Instead, set the environment variables DD_API_KEY and DD_APP_KEY.
 - [ ] ruby 2.6 is no longer supported. Please upgrade to ruby 2.7 or higher.
 - [ ] The options `--ssh` and `--ssshh` are no longer supported. Instead, please use `--quiet` to supress logging. `--debug` remains supported.
 - [ ] The environment variable `DATADOG_HOST` is no longer supported. Instead, please use `DD_SITE_URL`.
@@ -86,7 +86,7 @@ DD_API_KEY           | The Application key for the Datadog account
 
 ### Usage in a Github repo
 
-See [example/](https://github.com/scribd/datadog_backup/tree/master/example) for an example implementation as a repo that backs up your Datadog dashboards hourly.
+See [example/](https://github.com/scribd/datadog_backup/tree/main/example) for an example implementation as a repo that backs up your Datadog dashboards hourly.
 
 # Development
 

data/bin/datadog_backup

@@ -11,7 +11,6 @@ LOGGER.level = Logger::INFO
 
 require 'datadog_backup'
 
-
 def fatal(message)
   LOGGER.fatal(message)
   exit 1
@@ -19,10 +18,10 @@ end
 
 def options_valid?(options)
   %w[backup diffs restore].include?(options[:action])
-  %w[DD_API_KEY DD_APP_KEY].all? { |key| ENV[key] }
+  %w[DD_API_KEY DD_APP_KEY].all? { |key| ENV.fetch(key, nil) }
 end
 
-def prereqs(defaults)
+def prereqs(defaults) # rubocop:disable Metrics/AbcSize
   ARGV << '--help' if ARGV.empty?
 
   result = defaults.dup
@@ -49,6 +48,9 @@ def prereqs(defaults)
     opts.on('--dashboards-only') do
       result[:resources] = [DatadogBackup::Dashboards]
     end
+    opts.on('--synthetics-only') do
+      result[:resources] = [DatadogBackup::Synthetics]
+    end
     opts.on(
       '--json',
       'format backups as JSON instead of YAML. Does not impact `diffs` nor `restore`, but do not mix formats in the same backup-dir.'
@@ -78,9 +80,9 @@ defaults = {
   action: nil,
   backup_dir: File.join(ENV.fetch('PWD'), 'backup'),
   diff_format: :color,
-  resources: [DatadogBackup::Dashboards, DatadogBackup::Monitors],
+  resources: [DatadogBackup::Dashboards, DatadogBackup::Monitors, DatadogBackup::Synthetics],
   output_format: :yaml,
   force_restore: false
 }
 
-DatadogBackup::Cli.new(prereqs(defaults)).run!
+DatadogBackup::Cli.new(prereqs(defaults)).run!

data/datadog_backup.gemspec

@@ -13,13 +13,13 @@ Gem::Specification.new do |spec|
   spec.description   = 'A utility to backup and restore Datadog accounts'
   spec.homepage      = 'https://github.com/scribd/datadog_backup'
   spec.license       = 'MIT'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = ['>= 2.7']
+  spec.required_ruby_version = '>= 2.7'
 
   spec.add_dependency 'amazing_print'
   spec.add_dependency 'concurrent-ruby'
@@ -28,11 +28,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday'
   spec.add_dependency 'faraday-retry'
 
-
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rspec'

data/lib/datadog_backup/cli.rb

@@ -4,6 +4,7 @@ require 'optparse'
 require 'amazing_print'
 
 module DatadogBackup
+  # CLI is the command line interface for the datadog_backup gem.
   class Cli
     include ::DatadogBackup::Options
 
@@ -11,9 +12,9 @@ module DatadogBackup
       LOGGER.info("Starting diffs on #{::DatadogBackup::ThreadPool::TPOOL.max_length} threads")
       any_resource_instance
         .all_file_ids_for_selected_resources
-        .map do |id|
-        Concurrent::Promises.future_on(::DatadogBackup::ThreadPool::TPOOL, id) do |id|
-          [id, getdiff(id)]
+        .map do |file_id|
+        Concurrent::Promises.future_on(::DatadogBackup::ThreadPool::TPOOL, file_id) do |fid|
+          [fid, getdiff(fid)]
         end
       end
     end
@@ -32,32 +33,17 @@ module DatadogBackup
       matching_resource_instance(any_resource_instance.class_from_id(id))
     end
 
-    def diffs
-      futures = all_diff_futures
-      ::DatadogBackup::ThreadPool.watcher.join
-
-      format_diff_output(
-        Concurrent::Promises
-          .zip(*futures)
-          .value!
-          .compact
-      )
-    end
-
     def getdiff(id)
       result = definitive_resource_instance(id).diff(id)
       case result
-      when ''
-        nil
-      when "\n"
-        nil
-      when '<div class="diff"></div>'
+      when '---' || '' || "\n" || '<div class="diff"></div>'
         nil
       else
         result
       end
     end
 
+    # rubocop:disable Style/StringConcatenation
     def format_diff_output(diff_output)
       case diff_format
       when nil, :color
@@ -69,58 +55,31 @@ module DatadogBackup
           Diffy::CSS +
           '</style></head><body>' +
           diff_output.map do |id, diff|
-            "<br><br> ---<br><strong> id: #{id}</strong><br>" + diff
+            "<br><br> ---<br><strong> id: #{id}</strong><br>#{diff}"
           end.join('<br>') +
           '</body></html>'
       else
         raise 'Unexpected diff_format.'
       end
     end
+    # rubocop:enable Style/StringConcatenation
 
     def initialize(options)
       @options = options
     end
 
-    def matching_resource_instance(klass)
-      resource_instances.select { |resource_instance| resource_instance.instance_of?(klass) }.first
-    end
-
-    def resource_instances
-      @resource_instances ||= resources.map do |resource|
-        resource.new(@options)
-      end
-    end
-
     def restore
       futures = all_diff_futures
       watcher = ::DatadogBackup::ThreadPool.watcher
 
       futures.each do |future|
         id, diff = *future.value!
-        next unless diff
+        next if diff.nil? || diff.empty?
 
         if @options[:force_restore]
           definitive_resource_instance(id).restore(id)
         else
-          puts '--------------------------------------------------------------------------------'
-          puts format_diff_output([id, diff])
-          puts '(r)estore to Datadog, overwrite local changes and (d)ownload, (s)kip, or (q)uit?'
-          response = $stdin.gets.chomp
-          case response
-          when 'q'
-            exit
-          when 'r'
-            puts "Restoring #{id} to Datadog."
-            definitive_resource_instance(id).restore(id)
-          when 'd'
-            puts "Downloading #{id} from Datadog."
-            definitive_resource_instance(id).get_and_write_file(id)
-          when 's'
-            next
-          else
-            puts 'Invalid response, please try again.'
-            response = $stdin.gets.chomp
-          end
+          ask_to_restore(id, diff)
         end
       end
       watcher.join if watcher.status
@@ -131,5 +90,42 @@ module DatadogBackup
     rescue SystemExit, Interrupt
       ::DatadogBackup::ThreadPool.shutdown
     end
+
+    private
+
+    def ask_to_restore(id, diff)
+      puts '--------------------------------------------------------------------------------'
+      puts format_diff_output([id, diff])
+      puts '(r)estore to Datadog, overwrite local changes and (d)ownload, (s)kip, or (q)uit?'
+      loop do
+        response = $stdin.gets.chomp
+        case response
+        when 'q'
+          exit
+        when 'r'
+          puts "Restoring #{id} to Datadog."
+          definitive_resource_instance(id).restore(id)
+          break
+        when 'd'
+          puts "Downloading #{id} from Datadog."
+          definitive_resource_instance(id).get_and_write_file(id)
+          break
+        when 's'
+          break
+        else
+          puts 'Invalid response, please try again.'
+        end
+      end
+    end
+
+    def matching_resource_instance(klass)
+      resource_instances.select { |resource_instance| resource_instance.instance_of?(klass) }.first
+    end
+
+    def resource_instances
+      @resource_instances ||= resources.map do |resource|
+        resource.new(@options)
+      end
+    end
   end
 end

data/lib/datadog_backup/dashboards.rb

@@ -1,22 +1,17 @@
 # frozen_string_literal: true
 
 module DatadogBackup
-  class Dashboards < Core
-
-    def api_version
-      'v1'
-    end
-
-    def api_resource_name
-      'dashboard'
+  # Dashboards specific overrides for backup and restore.
+  class Dashboards < Resources
+    def all
+      get_all.fetch('dashboards')
     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,13 +22,23 @@ 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
     end
+
+    private
+
+    def api_version
+      'v1'
+    end
+
+    def api_resource_name
+      'dashboard'
+    end
+
+    def id_keyname
+      'id'
+    end
   end
 end

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::Resources
+  # 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,28 +1,21 @@
 # frozen_string_literal: true
 
 module DatadogBackup
-  class Monitors < Core
-    def all_monitors
-      @all_monitors ||= get_all
-    end
-
-    def api_version
-      'v1'
-    end
-
-    def api_resource_name
-      'monitor'
+  # Monitor specific overrides for backup and restore.
+  class Monitors < Resources
+    def all
+      get_all
     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
 
@@ -30,5 +23,15 @@ module DatadogBackup
       super(options)
       @banlist = %w[overall_state overall_state_modified matching_downtimes modified].freeze
     end
+
+    private
+
+    def api_version
+      'v1'
+    end
+
+    def api_resource_name
+      'monitor'
+    end
   end
 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]