brightbox-cli 4.8.0 → 5.0.0.rc1

data/spec/commands/sql/instances/update_spec.rb

@@ -30,7 +30,7 @@ describe "brightbox sql instances" do
       end
 
       it "sets custom maintenance window settings" do
-        expect(stderr).to eql("Updating dbs-12345\n")
+        expect(stderr).to include("Updating dbs-12345\n")
         expect(stdout).to include("dbs-12345")
       end
     end
@@ -54,7 +54,7 @@ describe "brightbox sql instances" do
         expect(Brightbox::DatabaseServer).to receive(:find).and_return(dbs)
         expect(dbs).to receive(:update).with(expected_args).and_call_original
 
-        expect(stderr).to eq("Updating dbs-12345\n")
+        expect(stderr).to include("Updating dbs-12345\n")
         expect(stdout).to include("dbs-12345")
       end
     end
@@ -78,7 +78,7 @@ describe "brightbox sql instances" do
         expect(Brightbox::DatabaseServer).to receive(:find).and_return(dbs)
         expect(dbs).to receive(:update).with(expected_args).and_call_original
 
-        expect(stderr).to eq("Updating dbs-432sf\n")
+        expect(stderr).to include("Updating dbs-432sf\n")
         expect(stdout).to include("dbs-432sf")
       end
     end

data/spec/commands/sql/snapshots/list_spec.rb

@@ -17,7 +17,7 @@ describe "brightbox sql snapshots" do
       let(:argv) { %w[sql snapshots list] }
 
       it "does not output to stderr" do
-        expect(stderr).to eql("")
+        expect(stderr).to be_empty unless ENV["DEBUG"]
       end
 
       it "outputs table details to stdout" do

data/spec/commands/sql/snapshots/show_spec.rb

@@ -8,21 +8,64 @@ describe "brightbox sql snapshots" do
 
     before do
       config = config_from_contents(USER_APP_CONFIG_CONTENTS)
-
-      # Setup in the VCR recordings
       cache_access_token(config, "f83da712e6299cda953513ec07f7a754f747d727")
     end
 
-    context "when resource exists", vcr: true do
+    context "without arguments" do
+      let(:argv) { %w[sql snapshots show] }
+
+      it "reports error" do
+        expect(stderr).to include("You must specify snapshot ids to show")
+        expect(stdout).to be_empty
+      end
+    end
+
+    context "with identifier argument" do
       let(:argv) { %w[sql snapshots show dbi-12345] }
+      let(:json_response) do
+        <<~EOS
+        {
+          "id": "dbi-12345",
+          "resource_type": "database_snapshot",
+          "url": "string",
+          "name": "string",
+          "description": "string",
+          "status": "creating",
+          "locked": true,
+          "database_engine": "string",
+          "database_version": "string",
+          "source": "string",
+          "source_trigger": "manual",
+          "size": 0,
+          "created_at": "2024-12-17T10:14:38.092Z",
+          "updated_at": "2024-12-17T10:14:38.092Z",
+          "deleted_at": "2024-12-17T10:14:38.092Z",
+          "account": {
+            "id": "acc-12345",
+            "resource_type": "account",
+            "url": "string",
+            "name": "string",
+            "description": "string",
+            "status": "pending"
+          },
+          "metadata": {
+            "labels": {}
+          }
+        }
+        EOS
+      end
 
-      it "does not output to stderr" do
-        expect(stderr).to eql("")
+      before do
+        stub_request(:get, "http://api.brightbox.localhost/1.0/database_snapshots/dbi-12345?account_id=acc-12345")
+          .to_return(status: 200, body: json_response)
       end
 
       it "outputs table details to stdout" do
-        expect(stdout).to_not be_empty
-        expect(stdout).to match(/dbi-12345/)
+        aggregate_failures do
+          expect(stderr).to be_empty unless ENV["DEBUG"]
+          expect(stdout).to_not be_empty
+          expect(stdout).to match(/dbi-12345/)
+        end
       end
     end
   end

data/spec/commands/volumes/attach_spec.rb

@@ -28,7 +28,7 @@ describe "brightbox volumes attach" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("ERROR: You must specify the volume ID as the first argument\n")
+      expect(stderr).to include("ERROR: You must specify the volume ID as the first argument\n")
 
       expect(stdout).to match("")
     end
@@ -40,7 +40,7 @@ describe "brightbox volumes attach" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("ERROR: You must specify the server ID to attach to as the second argument\n")
+      expect(stderr).to include("ERROR: You must specify the server ID to attach to as the second argument\n")
 
       expect(stdout).to match("")
     end
@@ -94,7 +94,7 @@ describe "brightbox volumes attach" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("Attaching vol-809s1\n")
+      expect(stderr).to include("Attaching vol-809s1\n")
 
       aggregate_failures do
         expect(stdout).to match("vol-809s1")
@@ -153,7 +153,7 @@ describe "brightbox volumes attach" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("Attaching vol-90328\n")
+      expect(stderr).to include("Attaching vol-90328\n")
 
       aggregate_failures do
         expect(stdout).to match("vol-90328")

data/spec/commands/volumes/copy_spec.rb

@@ -28,7 +28,7 @@ describe "brightbox volumes copy" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("ERROR: You must specify the volume ID as the first argument\n")
+      expect(stderr).to include("ERROR: You must specify the volume ID as the first argument\n")
 
       expect(stdout).to match("")
     end
@@ -66,7 +66,7 @@ describe "brightbox volumes copy" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("Copying vol-909ds\n")
+      expect(stderr).to include("Copying vol-909ds\n")
 
       expect(stdout).to match("vol-909ds")
     end

data/spec/commands/volumes/destroy_spec.rb

@@ -28,7 +28,7 @@ describe "brightbox volumes destroy" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("ERROR: You must specify volume IDs as arguments\n")
+      expect(stderr).to include("ERROR: You must specify volume IDs as arguments\n")
 
       expect(stdout).to match("")
     end

data/spec/commands/volumes/detach_spec.rb

@@ -28,7 +28,7 @@ describe "brightbox volumes detach" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("ERROR: You must specify volume IDs as arguments\n")
+      expect(stderr).to include("ERROR: You must specify volume IDs as arguments\n")
 
       expect(stdout).to match("")
     end

data/spec/commands/volumes/list_spec.rb

@@ -37,7 +37,7 @@ describe "brightbox volumes list" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("")
+      expect(stderr).to be_empty unless ENV["DEBUG"]
 
       aggregate_failures do
         expect(stdout).to match("id.*type.*size.*status.*server.*boot")

data/spec/commands/volumes/resize_spec.rb

@@ -28,7 +28,7 @@ describe "brightbox volumes resize" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("ERROR: You must specify the volume ID as the first argument\n")
+      expect(stderr).to include("ERROR: You must specify the volume ID as the first argument\n")
 
       expect(stdout).to match("")
     end
@@ -40,7 +40,7 @@ describe "brightbox volumes resize" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("ERROR: A 'size' option is required\n")
+      expect(stderr).to include("ERROR: A 'size' option is required\n")
 
       expect(stdout).to match("")
     end
@@ -85,7 +85,7 @@ describe "brightbox volumes resize" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("Resizing vol-op324\n")
+      expect(stderr).to include("Resizing vol-op324\n")
 
       aggregate_failures do
         expect(stdout).to match("vol-op324")

data/spec/commands/volumes/show_spec.rb

@@ -37,7 +37,7 @@ describe "brightbox volumes show" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("")
+      expect(stderr).to be_empty unless ENV["DEBUG"]
 
       aggregate_failures do
         expect(stdout).to match("id: vol-12345")

data/spec/commands/volumes/update_spec.rb

@@ -28,7 +28,7 @@ describe "brightbox volumes update" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("ERROR: You must specify the volume ID as the first argument\n")
+      expect(stderr).to include("ERROR: You must specify the volume ID as the first argument\n")
 
       expect(stdout).to match("")
     end
@@ -82,7 +82,7 @@ describe "brightbox volumes update" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("Updating vol-908us\n")
+      expect(stderr).to include("Updating vol-908us\n")
 
       aggregate_failures do
         expect(stdout).to match("vol-908us")
@@ -129,7 +129,7 @@ describe "brightbox volumes update" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("Updating vol-kl234\n")
+      expect(stderr).to include("Updating vol-kl234\n")
 
       aggregate_failures do
         expect(stdout).to match("vol-kl234")
@@ -176,7 +176,7 @@ describe "brightbox volumes update" do
     it "does not error" do
       expect { output }.to_not raise_error
 
-      expect(stderr).to eq("Updating vol-sdj2j\n")
+      expect(stderr).to include("Updating vol-sdj2j\n")
 
       aggregate_failures do
         expect(stdout).to match("vol-sdj2j")

data/spec/spec_helper.rb

@@ -1,3 +1,17 @@
+require "simplecov"
+
+SimpleCov.start do
+  add_filter "/spec/"
+  add_filter "/config/"
+  add_filter "/vendor/"
+
+  track_files "{lib}/**/*.rb"
+
+  # Currently just above 75% coverage - don't make it worse
+  minimum_coverage 75
+  refuse_coverage_drop
+end
+
 LIB_DIR = File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
 
 $LOAD_PATH.unshift LIB_DIR unless
@@ -28,6 +42,8 @@ TEST_RUNNER_HOME = ENV.fetch("HOME", nil)
 # Reduce the default fog timeout
 Fog.timeout = 10
 
+require "fog/brightbox"
+
 RSpec.configure do |config|
   config.include CommonHelpers
   config.include ConfigHelpers

data/spec/support/shared/api_resource_examples.rb

@@ -9,7 +9,32 @@ shared_examples "a wrapped API resource" do
   it { is_expected.to respond_to(:to_row) }
 
   it { is_expected.to respond_to(:to_s) }
+
   it "#to_s equals the #id" do
     expect(subject.to_s).to eql(subject.id)
   end
+
+  # describe "#attributes" do
+  #   subject { described_class.new(fog_model) }
+
+  #   let(:fog_model) do
+  #     double("Fog::Model", id: "res-12345", attributes: { id: "res-12345"})
+  #   end
+
+  #   it "returns an IndifferentAccessHash" do
+  #     expect(subject.attributes).to be_a(IndifferentAccessHash)
+  #   end
+  # end
+
+  # describe "#to_row" do
+  #   subject { described_class.new(fog_model) }
+
+  #   let(:fog_model) do
+  #     double("Fog::Model", id: "res-12345", attributes: { id: "res-12345"})
+  #   end
+
+  #   it "returns a Hash to avoid hirb errors" do
+  #     expect(subject.to_row).to be_a(Hash)
+  #   end
+  # end
 end

data/spec/unit/brightbox/account/attributes_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+RSpec.describe Brightbox::Account, "#attributes" do
+  subject { described_class.new(fog_model) }
+
+  let(:fog_model) do
+    double("Fog::Model", id: "res-12345", attributes: { id: "res-12345"})
+  end
+
+  it "returns an IndifferentAccessHash" do
+    expect(subject.attributes).to be_a(IndifferentAccessHash)
+  end
+end

data/spec/unit/brightbox/api/attributes_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+
+RSpec.describe Brightbox::Api, "#attributes" do
+  subject(:model_attributes) { api_model.attributes }
+
+  let(:api_model) { Brightbox::Api.new(fog_model) }
+  let(:fog_model) do
+    double(
+      "Fog::Compute::Brightbox::Api",
+      id: "res-12345",
+      attributes: attributes
+    )
+  end
+
+  context "when attributes are not set" do
+    let(:attributes) { nil }
+
+    it "returns an indifferent access hash" do
+      expect(model_attributes).to be_instance_of(IndifferentAccessHash)
+    end
+  end
+
+  context "when attributes are set with a mix of string and symbols" do
+    let(:attributes) do
+      {
+        id: "res-12345",
+        name: "test",
+        acme: acme_details
+      }
+    end
+    let(:acme_details) do
+      {
+        "domains" => [
+          {
+            "identifier" => "example.test",
+            "status" => "pending"
+          }
+        ]
+      }
+    end
+
+    it "transforms the keys with deep symbolize" do
+      expect(model_attributes).to eq(
+        id: "res-12345",
+        name: "test",
+        acme: {
+          domains: [
+            {
+              identifier: "example.test",
+              status: "pending"
+            }
+          ]
+        }
+      )
+    end
+
+    it "can accessed by string keys" do
+      expect(model_attributes["acme"]["domains"].first["identifier"]).to eq("example.test")
+    end
+
+    it "can accessed by symbol keys" do
+      expect(model_attributes[:acme][:domains].first[:identifier]).to eq("example.test")
+    end
+  end
+end

data/spec/unit/brightbox/api/fog_attributes_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+
+RSpec.describe Brightbox::Api, "#fog_attributes" do
+  subject(:model_attributes) { api_model.fog_attributes }
+
+  let(:api_model) { Brightbox::Api.new(fog_model) }
+  let(:fog_model) do
+    double(
+      "Fog::Compute::Brightbox::Api",
+      id: "res-12345",
+      attributes: attributes
+    )
+  end
+
+  context "when attributes are not set" do
+    let(:attributes) { nil }
+
+    it "returns an indifferent access hash" do
+      expect(model_attributes).to be_instance_of(IndifferentAccessHash)
+    end
+  end
+
+  context "when attributes are set with a mix of string and symbols" do
+    let(:attributes) do
+      {
+        id: "res-12345",
+        name: "test",
+        acme: acme_details
+      }
+    end
+    let(:acme_details) do
+      {
+        "domains" => [
+          {
+            "identifier" => "example.test",
+            "status" => "pending"
+          }
+        ]
+      }
+    end
+
+    it "transforms the keys with deep symbolize" do
+      expect(model_attributes).to eq(
+        id: "res-12345",
+        name: "test",
+        acme: {
+          domains: [
+            {
+              identifier: "example.test",
+              status: "pending"
+            }
+          ]
+        }
+      )
+    end
+
+    it "can not accessed by string keys" do
+      expect(model_attributes["acme"]["domains"].first["identifier"]).to eq("example.test")
+    end
+
+    it "can accessed by symbol keys" do
+      expect(model_attributes[:acme][:domains].first[:identifier]).to eq("example.test")
+    end
+  end
+end

data/spec/unit/brightbox/bb_config/config_directory_spec.rb

@@ -2,25 +2,45 @@ require "spec_helper"
 
 describe Brightbox::BBConfig do
   describe "#config_directory" do
+    context "when HOME is not set" do
+      let(:working_dir) { Dir.mktmpdir("working") }
+
+      before do
+        allow(Dir).to receive(:pwd).and_return(working_dir)
+        allow(ENV).to receive(:fetch).with("HOME", nil).and_return(nil)
+      end
+
+      it "returns current directory" do
+        config = Brightbox::BBConfig.new
+
+        expect(config.config_directory).to start_with(working_dir)
+        expect(config.config_directory).to end_with(".brightbox")
+      end
+    end
+
     context "when default location is used" do
       it "returns a String of the users `.brightbox` directory" do
         config = Brightbox::BBConfig.new
 
         expanded_path = File.expand_path("~/.brightbox")
-        expect(config.config_directory).to eql(expanded_path)
+        expect(config.config_directory).to eq(expanded_path)
       end
     end
 
     context "when absolute custom location is set" do
       let(:custom_dir) { Dir.mktmpdir("custom") }
 
+      after do
+        FileUtils.rm_rf(custom_dir)
+      end
+
       it "returns a String of the expanded directory" do
         config_options = {
           :directory => custom_dir
         }
         config = Brightbox::BBConfig.new(config_options)
 
-        expect(config.config_directory).to eql(custom_dir)
+        expect(config.config_directory).to eq(custom_dir)
       end
     end
 
@@ -32,7 +52,7 @@ describe Brightbox::BBConfig do
         config = Brightbox::BBConfig.new(config_options)
 
         expanded_path = File.expand_path("~/.cli_config")
-        expect(config.config_directory).to eql(expanded_path)
+        expect(config.config_directory).to eq(expanded_path)
       end
     end
   end

data/spec/unit/brightbox/cloud_ip/attributes_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+RSpec.describe Brightbox::CloudIP, "#attributes" do
+  subject { described_class.new(fog_model) }
+
+  let(:fog_model) do
+    double(
+      "Fog::Model",
+      id: "cip-12345",
+      destination_id: nil,
+      attributes: model_attributes
+    )
+  end
+  let(:model_attributes) { { id: "cip-12345" } }
+
+  it "returns an IndifferentAccessHash" do
+    expect(subject.attributes).to be_a(IndifferentAccessHash)
+  end
+end

data/spec/unit/brightbox/collaborating_account/attributes_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+RSpec.describe Brightbox::CollaboratingAccount, "#attributes" do
+  subject { described_class.new(fog_model) }
+
+  let(:fog_model) do
+    double("Fog::Model", id: "res-12345", attributes: { id: "res-12345"})
+  end
+
+  it "returns an IndifferentAccessHash" do
+    expect(subject.attributes).to be_a(IndifferentAccessHash)
+  end
+end

data/spec/unit/brightbox/database_server/attributes_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+RSpec.describe Brightbox::DatabaseServer, "#attributes" do
+  subject { described_class.new(fog_model) }
+
+  let(:fog_model) do
+    double("Fog::Model", id: "res-12345", attributes: { id: "res-12345"})
+  end
+
+  it "returns an IndifferentAccessHash" do
+    expect(subject.attributes).to be_a(IndifferentAccessHash)
+  end
+end

data/spec/unit/brightbox/database_snapshot/attributes_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+RSpec.describe Brightbox::DatabaseSnapshot, "#attributes" do
+  subject { described_class.new(fog_model) }
+
+  let(:fog_model) do
+    double("Fog::Model", id: "res-12345", attributes: { id: "res-12345"})
+  end
+
+  it "returns an IndifferentAccessHash" do
+    expect(subject.attributes).to be_a(IndifferentAccessHash)
+  end
+end

data/spec/unit/brightbox/database_type/attributes_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+RSpec.describe Brightbox::DatabaseType, "#attributes" do
+  subject { described_class.new(fog_model) }
+
+  let(:fog_model) do
+    double(
+      "Fog::Model",
+      id: "typ-12345",
+      attributes: model_attributes,
+      ram: 1024,
+      disk: 10_240,
+    )
+  end
+  let(:model_attributes) { { id: "typ-12345" } }
+
+  it "returns an IndifferentAccessHash" do
+    expect(subject.attributes).to be_a(IndifferentAccessHash)
+  end
+end

data/spec/unit/brightbox/detailed_server/attributes_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+RSpec.describe Brightbox::DetailedServer, "#attributes" do
+  subject { described_class.new(fog_model) }
+
+  let(:fog_model) do
+    double(
+      "Fog::Model",
+      id: "srv-12345",
+      attributes: model_attributes,
+      cloud_ips: [],
+      created_at: Time.parse("2025-01-01T12:00:00Z"),
+      created_on: "2025-01-01",
+      hostname: "srv-12345.gb1.brightbox.com",
+      image_id: "img-12345",
+      interfaces: [],
+      locked?: false,
+      type: "typ-12345",
+      state: "active",
+      server_type: "typ-12345",
+      zone: { id: "zon-12345", handle: "gb1-a" }
+    )
+  end
+  let(:model_attributes) { { id: "srv-12345" } }
+
+  it "returns an IndifferentAccessHash" do
+    expect(subject.attributes).to be_a(IndifferentAccessHash)
+  end
+end

data/spec/unit/brightbox/detailed_server_group/attributes_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+RSpec.describe Brightbox::DetailedServerGroup, "#attributes" do
+  subject { described_class.new(fog_model) }
+
+  let(:fog_model) do
+    double("Fog::Model", id: "res-12345", attributes: { id: "res-12345"})
+  end
+
+  it "returns an IndifferentAccessHash" do
+    expect(subject.attributes).to be_a(IndifferentAccessHash)
+  end
+end