datadog_backup 0.9.0

data/spec/datadog_backup/dashboards_spec.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DatadogBackup::Dashboards do
+  let(:client_double) { double }
+  let(:tempdir) { Dir.mktmpdir }
+  let(:dashboards) do
+    DatadogBackup::Dashboards.new(
+      action: 'backup',
+      client: client_double,
+      backup_dir: tempdir,
+      output_format: :json,
+      resources: [],
+      logger: Logger.new('/dev/null')
+    )
+  end
+  let(:dashboard_description) do
+    {
+      'description' => 'bar',
+      'id' => 'abc-123-def',
+      'title' => 'foo'
+    }
+  end
+  let(:all_boards) do
+    [
+      '200',
+      {
+        'dashboards' => [
+          dashboard_description
+        ]
+      }
+    ]
+  end
+  let(:example_dashboard) do
+    [
+      '200',
+      board_abc_123_def
+    ]
+  end
+  let(:board_abc_123_def) do
+    {
+      'graphs' => [
+        {
+          'definition' => {
+            'viz' => 'timeseries',
+            'requests' => [
+              {
+                'q' => 'min:foo.bar{a:b}',
+                'stacked' => false
+              }
+            ]
+          },
+          'title' => 'example graph'
+        }
+      ],
+      'description' => 'example dashboard',
+      'title' => 'example dashboard'
+    }
+  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)
+  end
+
+  describe '#backup' do
+    subject { dashboards.backup }
+
+    it 'is expected to create a file' do
+      file = 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(:close)
+
+      dashboards.backup
+    end
+  end
+
+  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
+    end
+  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

data/spec/datadog_backup/local_filesystem_spec.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DatadogBackup::LocalFilesystem do
+  let(:client_double) { double }
+  let(:tempdir) { Dir.mktmpdir }
+  let(:core) do
+    DatadogBackup::Core.new(
+      action: 'backup',
+      client: client_double,
+      backup_dir: tempdir,
+      resources: [DatadogBackup::Dashboards],
+      output_format: :json,
+      logger: Logger.new('/dev/null')
+    )
+  end
+  let(:core_yaml) do
+    DatadogBackup::Core.new(
+      action: 'backup',
+      client: client_double,
+      backup_dir: tempdir,
+      resources: [],
+      output_format: :yaml,
+      logger: Logger.new('/dev/null')
+    )
+  end
+
+  describe '#all_files' do
+    before(:example) do
+      File.new("#{tempdir}/all_files.json", 'w')
+    end
+
+    after(:example) do
+      FileUtils.rm "#{tempdir}/all_files.json"
+    end
+
+    subject { core.all_files }
+    it { is_expected.to eq(["#{tempdir}/all_files.json"]) }
+  end
+
+  describe '#all_file_ids_for_selected_resources' do
+    before(:example) do
+      Dir.mkdir("#{tempdir}/dashboards")
+      Dir.mkdir("#{tempdir}/monitors")
+      File.new("#{tempdir}/dashboards/all_files.json", 'w')
+      File.new("#{tempdir}/monitors/12345.json", 'w')
+    end
+
+    after(:example) do
+      FileUtils.rm "#{tempdir}/dashboards/all_files.json"
+      FileUtils.rm "#{tempdir}/monitors/12345.json"
+    end
+
+    subject { core.all_file_ids_for_selected_resources }
+    it { is_expected.to eq(['all_files']) }
+  end
+
+  describe '#class_from_id' do
+    before(:example) do
+      core.write_file('abc', "#{tempdir}/core/abc-123-def.json")
+    end
+
+    after(:example) do
+      FileUtils.rm "#{tempdir}/core/abc-123-def.json"
+    end
+    subject { core.class_from_id('abc-123-def') }
+    it { is_expected.to eq DatadogBackup::Core }
+  end
+
+  describe '#dump' do
+    context ':json' do
+      subject { core.dump({ a: :b }) }
+      it { is_expected.to eq(%({\n  "a": "b"\n})) }
+    end
+
+    context ':yaml' do
+      subject { core_yaml.dump({ 'a' => 'b' }) }
+      it { is_expected.to eq(%(---\na: b\n)) }
+    end
+  end
+
+  describe '#filename' do
+    context ':json' do
+      subject { core.filename('abc-123-def') }
+      it { is_expected.to eq("#{tempdir}/core/abc-123-def.json") }
+    end
+
+    context ':yaml' do
+      subject { core_yaml.filename('abc-123-def') }
+      it { is_expected.to eq("#{tempdir}/core/abc-123-def.yaml") }
+    end
+  end
+
+  describe '#file_type' do
+    before(:example) do
+      File.new("#{tempdir}/file_type.json", 'w')
+    end
+
+    after(:example) do
+      FileUtils.rm "#{tempdir}/file_type.json"
+    end
+
+    subject { core.file_type("#{tempdir}/file_type.json") }
+    it { is_expected.to eq :json }
+  end
+
+  describe '#find_file_by_id' do
+    before(:example) do
+      File.new("#{tempdir}/find_file.json", 'w')
+    end
+
+    after(:example) do
+      FileUtils.rm "#{tempdir}/find_file.json"
+    end
+
+    subject { core.find_file_by_id('find_file') }
+    it { is_expected.to eq "#{tempdir}/find_file.json" }
+  end
+
+  describe '#load_from_file' do
+    context ':json' do
+      subject { core.load_from_file(%({\n  "a": "b"\n}), :json) }
+      it { is_expected.to eq('a' => 'b') }
+    end
+
+    context ':yaml' do
+      subject { core.load_from_file(%(---\na: b\n), :yaml) }
+      it { is_expected.to eq('a' => 'b') }
+    end
+  end
+
+  describe '#load_from_file_by_id' do
+    context 'written in json read in yaml mode' do
+      before(:example) { core.write_file(%({"a": "b"}), "#{tempdir}/core/abc-123-def.json") }
+      after(:example) { FileUtils.rm "#{tempdir}/core/abc-123-def.json" }
+
+      subject { core_yaml.load_from_file_by_id('abc-123-def') }
+      it { is_expected.to eq('a' => 'b') }
+    end
+    context 'written in yaml read in json mode' do
+      before(:example) { core.write_file(%(---\na: b), "#{tempdir}/core/abc-123-def.yaml") }
+      after(:example) { FileUtils.rm "#{tempdir}/core/abc-123-def.yaml" }
+
+      subject { core.load_from_file_by_id('abc-123-def') }
+      it { is_expected.to eq('a' => 'b') }
+    end
+
+    context 'Integer as parameter' do
+      before(:example) { core.write_file(%(---\na: b), "#{tempdir}/core/12345.yaml") }
+      after(:example) { FileUtils.rm "#{tempdir}/core/12345.yaml" }
+
+      subject { core.load_from_file_by_id(12_345) }
+      it { is_expected.to eq('a' => 'b') }
+    end
+  end
+
+  describe '#write_file' do
+    subject { core.write_file('abc123', "#{tempdir}/core/abc-123-def.json") }
+    let(:file_like_object) { double }
+
+    it 'writes a file to abc-123-def.json' do
+      allow(File).to receive(:open).and_call_original
+      allow(File).to receive(:open).with("#{tempdir}/core/abc-123-def.json", 'w').and_return(file_like_object)
+      allow(file_like_object).to receive(:write)
+      allow(file_like_object).to receive(:close)
+
+      subject
+
+      expect(file_like_object).to have_received(:write).with('abc123')
+    end
+  end
+end

data/spec/datadog_backup/monitors_spec.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DatadogBackup::Monitors do
+  let(:client_double) { double }
+  let(:tempdir) { Dir.mktmpdir }
+  let(:monitors) do
+    DatadogBackup::Monitors.new(
+      action: 'backup',
+      client: client_double,
+      backup_dir: tempdir,
+      output_format: :json,
+      resources: [],
+      logger: Logger.new('/dev/null')
+    )
+  end
+  let(:monitor_description) do
+    {
+      'query' => 'bar',
+      'message' => 'foo',
+      'id' => 123_455,
+      'name' => 'foo',
+      'overall_state' => 'OK',
+      'overall_state_modified' => '2020-07-27T22:00:00+00:00'
+    }
+  end
+  let(:clean_monitor_description) do
+    {
+      'id' => 123_455,
+      'message' => 'foo',
+      'name' => 'foo',
+      'query' => 'bar'
+    }
+  end
+  let(:all_monitors) do
+    [
+      '200',
+      [
+        monitor_description
+      ]
+    ]
+  end
+  let(:example_monitor) do
+    [
+      '200',
+      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)
+  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
+
+  describe '#backup' do
+    subject { monitors.backup }
+
+    it 'is expected to create a file' do
+      file = double('file')
+      allow(File).to receive(:open).with(monitors.filename(123_455), 'w').and_return(file)
+      expect(file).to receive(:write).with(::JSON.pretty_generate(clean_monitor_description))
+      allow(file).to receive(:close)
+
+      monitors.backup
+    end
+  end
+
+  describe '#diff' 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(
+        [
+          '200',
+          [
+            {
+              'query' => 'bar',
+              'message' => 'foo',
+              'id' => 123_455,
+              'name' => 'foo',
+              'overall_state' => 'NO DATA',
+              'overall_state_modified' => '2020-07-27T22:55:55+00:00'
+            }
+          ]
+        ]
+      )
+
+      expect(monitors.diff(123_455)).to eq ''
+
+      FileUtils.rm monitors.filename(123_455)
+    end
+  end
+
+  describe '#filename' do
+    subject { monitors.filename(123_455) }
+    it { is_expected.to eq("#{tempdir}/monitors/123455.json") }
+  end
+
+  describe '#get_by_id' do
+    context 'Integer' do
+      subject { monitors.get_by_id(123_455) }
+      it { is_expected.to eq monitor_description }
+    end
+    context 'String' do
+      subject { monitors.get_by_id('123455') }
+      it { is_expected.to eq monitor_description }
+    end
+  end
+end

data/spec/datadog_backup_bin_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'climate_control'
+require 'timeout'
+
+describe 'bin/datadog_backup' do
+  # Contract Or[nil,String] => self
+  def run_bin(args = '', input = nil)
+    status = nil
+    output = ''
+    cmd = "bin/datadog_backup #{args}"
+    Open3.popen2e(cmd) do |i, oe, t|
+      pid = t.pid
+
+      if input
+        i.puts input
+        i.close
+      end
+
+      Timeout.timeout(1.0) do
+        oe.each do |v|
+          output += v
+        end
+      end
+    rescue Timeout::Error
+      LOGGER.warn "Timing out #{t.inspect} after 1 second"
+      Process.kill(15, pid)
+    ensure
+      status = t.value
+    end
+    [output, status]
+  end
+
+  required_vars = %w[
+    DATADOG_API_KEY
+    DATADOG_APP_KEY
+  ]
+
+  before do
+    required_vars.each do |v|
+      ClimateControl.env[v] = v.downcase
+    end
+  end
+
+  required_vars.map do |v|
+    it "dies unless given ENV[#{v}]" do
+      ClimateControl.env[v] = nil
+      _, status = run_bin('backup')
+      expect(status).to_not be_success
+    end
+  end
+
+  it 'supplies help' do
+    out_err, status = run_bin('--help')
+    expect(out_err).to match(/Usage: datadog_backup/)
+    expect(status).to be_success
+  end
+end