datadog_backup 3.1.1 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 332899376b51dd8ad98dda7a3528b7a7c80ca8cbbd2c4bbe9c2cb9976a1c7024
-  data.tar.gz: 68b89a77b5148006b16388c7a93241ca50fcecb6bc4edc09ab36cf34a80d92e8
+  metadata.gz: 2e3e8528c064d05b09bd31080a7bcab7c77fcca8dde46949cf8c62a7702f2af1
+  data.tar.gz: 24c57007224fcf546b5a886e4b9f2a78f76b2a63fd2c64067ae2454192919848
 SHA512:
-  metadata.gz: ab35b9e6a6152cc22ff3de7714ed60f2bca54c056a510d5726e5d33921a0f54d088195bfd7b992494545ccdfa8350e99e097c19155cfde4f7396049aeaad9650
-  data.tar.gz: 4f2f791146658c9a9e4185ef3bda43180a5ef46938dd6b2754aa493bcac9949f19a53f70b972a125ae51ad7b71f6f8c309767d83654e40a4d7d5f4be70e6c39c
+  metadata.gz: d5180a6ba1f92f5db842e88d337878eacd0bafe114fbbb8752153b85f7c47f682be3bdd529b694294cc5523fe4c94274a7ee78d15fc4798b327598fb7710303b
+  data.tar.gz: f4ccccd735136f06f92cc71f1df0176e5fa626fd36f5e60f4bc88ef93f9fcf31f8d840c523e1e70f08195faf8d32e8522fea3665e9b6f1efe280cf8b214331a9

data/.github/workflows/validate-pr.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
     - name: Validate PR Title
-      uses: amannn/action-semantic-pull-request@v4
+      uses: amannn/action-semantic-pull-request@v5.0.2
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [3.2.1](https://github.com/scribd/datadog_backup/compare/v3.2.0...v3.2.1) (2023-02-11)
+
+
+### Bug Fixes
+
+* update error handling for restore ([233b1b2](https://github.com/scribd/datadog_backup/commit/233b1b27d485e7502dd47ca01670cea0576e920d))
+
+# [3.2.0](https://github.com/scribd/datadog_backup/compare/v3.1.1...v3.2.0) (2023-02-10)
+
+
+### Features
+
+* Deepsort skip sorting arrays ([d9cba97](https://github.com/scribd/datadog_backup/commit/d9cba97015d1af636ca9c03605ef14fa8dcb6d21))
+
 ## [3.1.1](https://github.com/scribd/datadog_backup/compare/v3.1.0...v3.1.1) (2022-09-01)
 
 

data/README.md

@@ -71,6 +71,7 @@ parameter            | description
 --no-color           | removes colored output from diff format
 --diff-format FORMAT | one of `color`, `html_simple`, `html`                                                                                         | `color`
 --force-restore      | Force restore to Datadog. Do not ask to validate. Non-interactive.
+--disable-array-sort | Do not sort array elements, to preserver order of dashboard widgets.
 --h, --help          | help
 
 ## Environment variables

data/bin/datadog_backup

@@ -66,6 +66,9 @@ def prereqs(defaults) # rubocop:disable Metrics/AbcSize
     opts.on('--force-restore', 'Force restore to Datadog. Do not ask to validate. Non-interactive.') do
       result[:force_restore] = true
     end
+    opts.on('--disable-array-sort', 'Do not sort array elements, to preserver order of dashboard widgets.') do
+      result[:disable_array_sort] = true
+    end
   end
   options.parse!
 
@@ -82,7 +85,8 @@ defaults = {
   diff_format: :color,
   resources: [DatadogBackup::Dashboards, DatadogBackup::Monitors, DatadogBackup::Synthetics],
   output_format: :yaml,
-  force_restore: false
+  force_restore: false,
+  disable_array_sort: false
 }
 
 DatadogBackup::Cli.new(prereqs(defaults)).run!

data/lib/datadog_backup/dashboards.rb

@@ -22,6 +22,15 @@ module DatadogBackup
       Concurrent::Promises.zip(*futures).value!
     end
 
+    def get_by_id(id)
+      begin
+        dashboard = except(get(id))
+      rescue Faraday::ResourceNotFound => e
+        dashboard = {}
+      end
+      except(dashboard)
+    end
+
     def initialize(options)
       super(options)
       @banlist = %w[modified_at url].freeze

data/lib/datadog_backup/local_filesystem.rb

@@ -32,9 +32,9 @@ module DatadogBackup
     def dump(object)
       case output_format
       when :json
-        JSON.pretty_generate(object.deep_sort)
+        JSON.pretty_generate(object.deep_sort(array: disable_array_sort ? false : true))
       when :yaml
-        YAML.dump(object.deep_sort)
+        YAML.dump(object.deep_sort(array: disable_array_sort ? false : true))
       else
         raise 'invalid output_format specified or not specified'
       end

data/lib/datadog_backup/options.rb

@@ -31,5 +31,9 @@ module DatadogBackup
     def force_restore
       @options[:force_restore]
     end
+
+    def disable_array_sort
+      @options[:disable_array_sort]
+    end
   end
 end

data/lib/datadog_backup/resources.rb

@@ -26,8 +26,8 @@ module DatadogBackup
     # Returns the diffy diff.
     # Optionally, supply an array of keys to remove from comparison
     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
+      current = except(get_by_id(id)).deep_sort(array: disable_array_sort ? false : true).to_yaml
+      filesystem = except(load_from_file_by_id(id)).deep_sort(array: disable_array_sort ? false : true).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 filesystem: #{filesystem} <=> current: #{current} == result: #{result}")
       result.chomp
@@ -110,9 +110,7 @@ module DatadogBackup
       body = load_from_file_by_id(id)
       begin
         update(id, body)
-      rescue RuntimeError => e
-        raise e.message unless e.message.include?('update failed with error 404')
-
+      rescue Faraday::ResourceNotFound => e
         create_newly(id, body)
       end
     end

data/lib/datadog_backup/version.rb

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

data/spec/datadog_backup/core_spec.rb

@@ -103,7 +103,7 @@ describe DatadogBackup::Resources do
       allow(resources).to receive(:api_resource_name).and_return('api-resource-name-string')
       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' }]
+        raise Faraday::ResourceNotFound
       end
       allow(resources).to receive(:load_from_file_by_id).and_return({ 'load' => 'ok' })
     end
@@ -126,7 +126,7 @@ describe DatadogBackup::Resources do
       before do
         allow(resources).to receive(:load_from_file_by_id).and_return({ 'load' => 'ok' })
         stubs.put('/api/api-version-string/api-resource-name-string/bad-123-id') do
-          [404, {}, { 'error' => 'id not found' }]
+          raise Faraday::ResourceNotFound
         end
         stubs.post('/api/api-version-string/api-resource-name-string', { 'load' => 'ok' }) do
           respond_with200({ 'id' => 'my-new-id' })

data/spec/datadog_backup/local_filesystem_spec.rb

@@ -20,6 +20,15 @@ describe DatadogBackup::LocalFilesystem do
       output_format: :yaml
     )
   end
+  let(:resources_disable_array_sort) do
+    DatadogBackup::Resources.new(
+      action: 'backup',
+      backup_dir: tempdir,
+      resources: [DatadogBackup::Dashboards],
+      output_format: :json,
+      disable_array_sort: true
+    )
+  end
 
   describe '#all_files' do
     subject { resources.all_files }
@@ -79,6 +88,18 @@ describe DatadogBackup::LocalFilesystem do
 
       it { is_expected.to eq(%(---\na: b\n)) }
     end
+
+    context 'when array sorting is enabled' do
+      subject { resources.dump({ a: [ :c, :b ] }) }
+
+      it { is_expected.to eq(%({\n  \"a\": [\n    \"b\",\n    \"c\"\n  ]\n})) }
+    end
+
+    context 'when array sorting is disabled' do
+      subject { resources_disable_array_sort.dump({ a: [ :c, :b ] }) }
+
+      it { is_expected.to eq(%({\n  \"a\": [\n    \"c\",\n    \"b\"\n  ]\n})) }
+    end
   end
 
   describe '#filename' do

data/spec/datadog_backup/synthetics_spec.rb

@@ -231,7 +231,7 @@ describe DatadogBackup::Synthetics do
 
       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.put('/api/v1/synthetics/tests/api/restore-invalid-id') { raise Faraday::ResourceNotFound }
         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' }])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datadog_backup
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.1
 platform: ruby
 authors:
 - Kamran Farhadi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-01 00:00:00.000000000 Z
+date: 2023-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print