datadog_backup 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c069dccdefa9573c4fcd1e0e49292813203455a7b76e670c156a47936aa82b32
-  data.tar.gz: 17c9f91c0de0a2a3975525c01f843f30bba77b43676c903a02472a1c576953ca
+  metadata.gz: a99c7fdf81fb1fafa9e2c8b2c4e28a7a2685d4c1a6482eede1aefd08322167bc
+  data.tar.gz: ac4f8c37ac22dc4c9893153afa27678e4abb98d70a4cb2a47574bf26e1b5c8da
 SHA512:
-  metadata.gz: 7200fc88e53d944655028f91455d015a788ab4529f6cf21739dc23631ba168945d664bbcf9c000b81ce44be85ce33f2c6d964a1aa40625cbf93a601dec5d0df1
-  data.tar.gz: b570dc952f7a9b93817970a2f897b005c6e81c1abb2d99988c32567cc7380a6042af3fb8a6e0e8d858a4d4447d681da762e389e434ee51446e7427b0d6864181
+  metadata.gz: ae3e46853cda4a9dc988624c169ad104c2a3737081f04ed5c33a1bfe6f24a752e6bd6fadfd0d9d1dc8545b135b95829044fd4748abd45ef6cd43c4d3258662d9
+  data.tar.gz: 39136571658e67c317b00a31b21b67169026e958cedf987dbb57c0b8af9a5cf8f944ed9617a1fd736a591aaa8c22559b4405fd5e17641dcf6fe911dac0484668

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@v5.0.2
+      uses: amannn/action-semantic-pull-request@v5.2.0
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [3.3.0](https://github.com/scribd/datadog_backup/compare/v3.2.1...v3.3.0) (2023-08-17)
+
+
+### Features
+
+* backup SLOs ([#155](https://github.com/scribd/datadog_backup/issues/155)) ([6cca6e7](https://github.com/scribd/datadog_backup/commit/6cca6e7567895673e94c7de80022c821553698ee)), closes [#1](https://github.com/scribd/datadog_backup/issues/1)
+
+## [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)
 
 

data/bin/datadog_backup

@@ -48,6 +48,9 @@ def prereqs(defaults) # rubocop:disable Metrics/AbcSize
     opts.on('--dashboards-only') do
       result[:resources] = [DatadogBackup::Dashboards]
     end
+    opts.on('--slos-only') do
+      result[:resources] = [DatadogBackup::SLOs]
+    end
     opts.on('--synthetics-only') do
       result[:resources] = [DatadogBackup::Synthetics]
     end
@@ -83,7 +86,7 @@ defaults = {
   action: nil,
   backup_dir: File.join(ENV.fetch('PWD'), 'backup'),
   diff_format: :color,
-  resources: [DatadogBackup::Dashboards, DatadogBackup::Monitors, DatadogBackup::Synthetics],
+  resources: [DatadogBackup::Dashboards, DatadogBackup::Monitors, DatadogBackup::SLOs, DatadogBackup::Synthetics],
   output_format: :yaml,
   force_restore: false,
   disable_array_sort: false

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/resources.rb

@@ -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/slos.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module DatadogBackup
+  # SLO specific overrides for backup and restore.
+  class SLOs < Resources
+    def all
+      get_all
+    end
+
+    def backup
+      LOGGER.info("Starting diffs on #{::DatadogBackup::ThreadPool::TPOOL.max_length} threads")
+      futures = all.map do |slo|
+        Concurrent::Promises.future_on(::DatadogBackup::ThreadPool::TPOOL, slo) do |board|
+          id = board[id_keyname]
+          get_and_write_file(id)
+        end
+      end
+
+      watcher = ::DatadogBackup::ThreadPool.watcher
+      watcher.join if watcher.status
+
+      Concurrent::Promises.zip(*futures).value!
+    end
+
+    def get_by_id(id)
+      begin
+        slo = except(get(id))
+      rescue Faraday::ResourceNotFound => e
+        slo = {}
+      end
+      except(slo)
+    end
+
+    def initialize(options)
+      super(options)
+      @banlist = %w[modified_at url].freeze
+    end
+
+    # Return the Faraday body from a response with a 2xx status code, otherwise raise an error
+    def body_with_2xx(response)
+      unless response.status.to_s =~ /^2/
+        raise "#{caller_locations(1,
+                                  1)[0].label} failed with error #{response.status}"
+      end
+
+      response.body.fetch('data')
+    end
+
+    private
+
+    def api_version
+      'v1'
+    end
+
+    def api_resource_name
+      'slo'
+    end
+
+    def id_keyname
+      'id'
+    end
+  end
+end

data/lib/datadog_backup/version.rb

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

data/lib/datadog_backup.rb

@@ -8,6 +8,7 @@ require_relative 'datadog_backup/cli'
 require_relative 'datadog_backup/resources'
 require_relative 'datadog_backup/dashboards'
 require_relative 'datadog_backup/monitors'
+require_relative 'datadog_backup/slos'
 require_relative 'datadog_backup/synthetics'
 require_relative 'datadog_backup/thread_pool'
 require_relative 'datadog_backup/version'

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/slos_spec.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DatadogBackup::SLOs do
+  let(:stubs) { Faraday::Adapter::Test::Stubs.new }
+  let(:api_client_double) { Faraday.new { |f| f.adapter :test, stubs } }
+  let(:tempdir) { Dir.mktmpdir }
+  let(:slos) do
+    slos = described_class.new(
+      action: 'backup',
+      backup_dir: tempdir,
+      output_format: :json,
+      resources: []
+    )
+    allow(slos).to receive(:api_service).and_return(api_client_double)
+    return slos
+  end
+  let(:fetched_slos) do
+    {
+      "data"=>[
+        {"id"=>"abc-123", "name"=>"CI Stability", "tags"=>["kind:availability", "team:my_team"], "monitor_tags"=>[], "thresholds"=>[{"timeframe"=>"7d", "target"=>98.0, "target_display"=>"98."}, {"timeframe"=>"30d", "target"=>98.0, "target_display"=>"98."}, {"timeframe"=>"90d", "target"=>98.0, "target_display"=>"98."}], "type"=>"metric", "type_id"=>1, "description"=>"something helpful", "timeframe"=>"30d", "target_threshold"=>98.0, "query"=>{"denominator"=>"sum:metric.ci_things{*}.as_count()", "numerator"=>"sum:metric.ci_things{*}.as_count()-sum:metric.ci_things{infra_failure}.as_count()"}, "creator"=>{"name"=>"Thelma Patterson", "handle"=>"thelma.patterson@example.com", "email"=>"thelma.patterson@example.com"}, "created_at"=>1571335531, "modified_at"=>1687844157},
+        {"id"=>"sbc-124", "name"=>"A Latency SLO", "tags"=>["team:my_team", "kind:latency"], "monitor_tags"=>[], "thresholds"=>[{"timeframe"=>"7d", "target"=>95.0, "target_display"=>"95."}, {"timeframe"=>"30d", "target"=>95.0, "target_display"=>"95."}, {"timeframe"=>"90d", "target"=>95.0, "target_display"=>"95."}], "type"=>"monitor", "type_id"=>0, "description"=>"", "timeframe"=>"30d", "target_threshold"=>95.0, "monitor_ids"=>[13158755], "creator"=>{"name"=>"Louise Montague", "handle"=>"louise.montague@example.com", "email"=>"louise.montague@example.com"}, "created_at"=>1573162531, "modified_at"=>1685819875}
+      ],
+      "errors"=>[],
+      "metadata"=>{"page"=>{"total_count"=>359, "total_filtered_count"=>359}}
+    }
+  end
+  let(:slo_abc_123) do
+    {
+      "id" => "abc-123",
+      "name" => "CI Stability",
+      "tags" => [
+        "kind:availability",
+        "team:my_team",
+      ],
+      "monitor_tags" => [],
+      "thresholds" => [
+        {
+          "timeframe" => "7d",
+          "target" => 98.0,
+          "target_display" => "98."
+        },
+        {
+          "timeframe" => "30d",
+          "target" => 98.0,
+          "target_display" => "98."
+        },
+        {
+          "timeframe" => "90d",
+          "target" => 98.0,
+          "target_display" => "98."
+        }
+      ],
+      "type" => "metric",
+      "type_id" => 1,
+      "description" => "something helpful",
+      "timeframe" => "30d",
+      "target_threshold" => 98.0,
+      "query" => {
+        "denominator" => "sum:metric.ci_things{*}.as_count()",
+        "numerator" => "sum:metric.ci_things{*}.as_count()-sum:metric.ci_things{infra_failure}.as_count()"
+      },
+      "creator" => {
+        "name" => "Thelma Patterson",
+        "handle" => "thelma.patterson@example.com",
+        "email" => "thelma.patterson@example.com"
+      },
+      "created_at" => 1571335531,
+      "modified_at" => 1687844157
+    }
+  end
+  let(:slo_sbc_124) do
+    {
+      "id" => "sbc-124",
+      "name" => "A Latency SLO",
+      "tags" => [
+        "kind:latency",
+        "team:my_team",
+      ],
+      "monitor_tags" => [],
+      "thresholds" => [
+        {
+          "timeframe" => "7d",
+          "target" => 98.0,
+          "target_display" => "98."
+        },
+        {
+          "timeframe" => "30d",
+          "target" => 98.0,
+          "target_display" => "98."
+        },
+        {
+          "timeframe" => "90d",
+          "target" => 98.0,
+          "target_display" => "98."
+        }
+      ],
+      "type" => "monitor",
+      "type_id"=>0,
+      "description"=>"",
+      "timeframe"=>"30d",
+      "target_threshold"=>95.0,
+      "monitor_ids"=>[ 13158755 ],
+      "creator"=>{
+        "name"=>"Louise Montague",
+        "handle"=>"louise.montague@example.com",
+        "email"=>"louise.montague@example.com"
+      },
+      "created_at"=>1573162531,
+      "modified_at"=>1685819875
+    }
+  end
+  let(:slo_abc_123_response) do
+    { "data" => slo_abc_123, "errors" => [] }
+  end
+  let(:slo_sbc_124_response) do
+    { "data" => slo_sbc_124, "errors" => [] }
+  end
+  let(:all_slos) { respond_with200(fetched_slos) }
+  let(:example_slo1) { respond_with200(slo_abc_123_response) }
+  let(:example_slo2) { respond_with200(slo_sbc_124_response) }
+
+  before do
+    stubs.get('/api/v1/slo') { all_slos }
+    stubs.get('/api/v1/slo/abc-123') { example_slo1 }
+    stubs.get('/api/v1/slo/sbc-124') { example_slo2 }
+  end
+
+  describe '#backup' do
+    subject { slos.backup }
+
+    it 'is expected to create two files' do
+      file1 = instance_double(File)
+      allow(File).to receive(:open).with(slos.filename('abc-123'), 'w').and_return(file1)
+      allow(file1).to receive(:write)
+      allow(file1).to receive(:close)
+
+      file2 = instance_double(File)
+      allow(File).to receive(:open).with(slos.filename('sbc-124'), 'w').and_return(file2)
+      allow(file2).to receive(:write)
+      allow(file2).to receive(:close)
+
+      slos.backup
+      expect(file1).to have_received(:write).with(::JSON.pretty_generate(slo_abc_123.deep_sort))
+      expect(file2).to have_received(:write).with(::JSON.pretty_generate(slo_sbc_124.deep_sort))
+    end
+  end
+
+  describe '#filename' do
+    subject { slos.filename('abc-123') }
+
+    it { is_expected.to eq("#{tempdir}/slos/abc-123.json") }
+  end
+
+  describe '#get_by_id' do
+    subject { slos.get_by_id('abc-123') }
+
+    it { is_expected.to eq slo_abc_123 }
+  end
+
+  describe '#diff' do
+    it 'calls the api only once' do
+      slos.write_file('{"a":"b"}', slos.filename('abc-123'))
+      expect(slos.diff('abc-123')).to eq(<<~EODASH
+         ---
+        -created_at: 1571335531
+        -creator:
+        -  email: thelma.patterson@example.com
+        -  handle: thelma.patterson@example.com
+        -  name: Thelma Patterson
+        -description: something helpful
+        -id: abc-123
+        -monitor_tags: []
+        -name: CI Stability
+        -query:
+        -  denominator: sum:metric.ci_things{*}.as_count()
+        -  numerator: sum:metric.ci_things{*}.as_count()-sum:metric.ci_things{infra_failure}.as_count()
+        -tags:
+        -- kind:availability
+        -- team:my_team
+        -target_threshold: 98.0
+        -thresholds:
+        -- target: 98.0
+        -  target_display: '98.'
+        -  timeframe: 30d
+        -- target: 98.0
+        -  target_display: '98.'
+        -  timeframe: 7d
+        -- target: 98.0
+        -  target_display: '98.'
+        -  timeframe: 90d
+        -timeframe: 30d
+        -type: metric
+        -type_id: 1
+        +a: b
+      EODASH
+      .chomp)
+    end
+  end
+
+  describe '#except' do
+    subject { slos.except({ :a => :b, 'modified_at' => :c, 'url' => :d }) }
+
+    it { is_expected.to eq({ a: :b }) }
+  end
+end

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.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Kamran Farhadi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-10 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -229,6 +229,7 @@ files:
 - lib/datadog_backup/monitors.rb
 - lib/datadog_backup/options.rb
 - lib/datadog_backup/resources.rb
+- lib/datadog_backup/slos.rb
 - lib/datadog_backup/synthetics.rb
 - lib/datadog_backup/thread_pool.rb
 - lib/datadog_backup/version.rb
@@ -239,6 +240,7 @@ files:
 - spec/datadog_backup/deprecations_spec.rb
 - spec/datadog_backup/local_filesystem_spec.rb
 - spec/datadog_backup/monitors_spec.rb
+- spec/datadog_backup/slos_spec.rb
 - spec/datadog_backup/synthetics_spec.rb
 - spec/datadog_backup_bin_spec.rb
 - spec/spec_helper.rb