brightbox-cli 3.2.0 → 4.0.0

data/spec/commands/zones/list_spec.rb

@@ -1,14 +1,13 @@
 require "spec_helper"
 
 describe "brightbox zones" do
-
   describe "list" do
     let(:output) { FauxIO.new { Brightbox.run(argv) } }
     let(:stdout) { output.stdout }
     let(:stderr) { output.stderr }
 
     context "" do
-      let(:argv) { %w(zones list) }
+      let(:argv) { %w[zones list] }
 
       it "does not error" do
         expect { output }.to_not raise_error

data/spec/configs/api_client.ini

@@ -2,7 +2,7 @@
 default_client = testing
 
 [testing]
-api_url = http://api.brightbox.dev
+api_url = http://api.brightbox.localhost
 alias = testing
 client_id = cli-12345
 secret = qy6xxnvy4o0tgv5

data/spec/configs/user_app.ini

@@ -4,7 +4,7 @@ default_client = testing
 [testing]
 alias = testing
 username = jason.null@brightbox.com
-api_url = http://api.brightbox.dev
-auth_url = http://api.brightbox.dev
+api_url = http://api.brightbox.localhost
+auth_url = http://api.brightbox.localhost
 default_account = acc-12345
 

data/spec/spec_helper.rb

@@ -23,18 +23,31 @@ API_CLIENT_CONFIG_CONTENTS = File.read(File.join(File.dirname(__FILE__), "config
 USER_APP_CONFIG_CONTENTS = File.read(File.join(File.dirname(__FILE__), "configs/user_app.ini"))
 
 # Remember the $HOME of the test runner
-TEST_RUNNER_HOME = ENV["HOME"]
+TEST_RUNNER_HOME = ENV.fetch("HOME", nil)
+
+# Reduce the default fog timeout
+Fog.timeout = 10
 
 RSpec.configure do |config|
   config.include CommonHelpers
   config.include ConfigHelpers
+  config.include AuthenticationHelpers
   config.include TokenHelpers
   config.include PasswordPromptHelpers
 
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  config.expect_with :rspec do |c|
+    c.max_formatted_output_length = nil
+  end
+
   config.before do
     # For each test, point to the testing endpoint to make it safer and easier to
-    # record from dev endpoints. Devs can DNS api.brightbox.dev to their dev service
-    stub_const("Brightbox::DEFAULT_API_ENDPOINT", ENV["BRIGHTBOX_API_URL"] || "http://api.brightbox.dev")
+    # record from dev endpoints. Devs can DNS api.brightbox.localhost to their dev service
+    stub_const("Brightbox::DEFAULT_API_ENDPOINT", ENV.fetch("BRIGHTBOX_API_URL", "http://api.brightbox.localhost"))
     # And set a sane terminal size for Hirb
     ENV["COLUMNS"] = "120"
     ENV["LINES"] = "120"

data/spec/support/authentication_helpers.rb

@@ -0,0 +1,98 @@
+module AuthenticationHelpers
+  def api_url
+    "http://api.brightbox.localhost"
+  end
+
+  def stub_client_token_request
+    stub_request(:post, "http://api.brightbox.localhost/token").to_return(
+      :status => 200,
+      :body => '{"access_token":"44320b29286077c44f14c4efdfed70f63f4a8361","token_type":"Bearer","refresh_token":"759b2b28c228948a0ba5d07a89f39f9e268a95c0","scope":"infrastructure orbit","expires_in":7200}'
+    )
+  end
+
+  def stub_token_request(two_factor: false)
+    auth_response = {
+      status: 200,
+      body: {
+        access_token: "17e9282e40b8a2f1366107a068a1632bb65d3dec",
+        token_type: "Bearer",
+        refresh_token: "b77913a13cccfdd44294b4b161494a652d48b635",
+        scope: "infrastructure, orbit",
+        expires_in: 7200
+      }.to_json
+    }
+
+    if two_factor
+      stub_request(:post, "#{api_url}/token")
+        .with(
+          body: {
+            grant_type: "password",
+            username: "jason.null@brightbox.com",
+            password: "N:B3e%7Cmh"
+          }.to_json
+        )
+        .to_return(
+          status: 401,
+          headers: {
+            "X-Brightbox-OTP" => "required"
+          },
+          body: { error: "invalid_client" }.to_json
+        )
+
+      stub_request(:post, "#{api_url}/token")
+        .with(
+          headers: {
+            "X-Brightbox-OTP" => "123456"
+          },
+          body: {
+            grant_type: "password",
+            username: "jason.null@brightbox.com",
+            password: "N:B3e%7Cmh+123456"
+          }.to_json
+        )
+        .to_return(auth_response)
+    else
+      stub_request(:post, "#{api_url}/token")
+        .with(
+          body: {
+            grant_type: "password",
+            username: "jason.null@brightbox.com",
+            password: "N:B3e%7Cmh"
+          }.to_json
+        )
+        .to_return(auth_response)
+    end
+  end
+
+  def stub_accounts_request
+    stub_request(:get, "#{api_url}/1.0/accounts?nested=false")
+      .to_return(
+        status: 200,
+        headers: { "Content-Type": "application/json" },
+        body: [
+          {
+            id: "acc-12345",
+            resource_type: "account",
+            url: "https://api.gb1.brightbox.com/1.0/accounts/acc-12345",
+            name: "CLI test account",
+            status: "active",
+            ram_limit: 3_200_000,
+            ram_used: 0,
+            dbs_ram_limit: 32_768,
+            dbs_ram_used: 0,
+            cloud_ips_limit: 32,
+            cloud_ips_used: 0,
+            load_balancers_limit: 5,
+            load_balancers_used: 0,
+            owner: {
+              id: "usr-12345",
+              resource_type: "user",
+              url: "https://api.gb1.brightbox.com/1.0/users/usr-12345",
+              name: "Jason Null",
+              email_address: "jason.null@brightbox.com"
+            }
+          }
+        ].to_json
+      )
+  end
+end

data/spec/support/config_helpers.rb

@@ -12,9 +12,7 @@ module ConfigHelpers
 
     # Load the contents into the expected location
     FileUtils.mkdir_p config.config_directory
-    File.open(config.config_filename, "w") do |f|
-      f.write contents
-    end
+    File.write(config.config_filename, contents)
 
     config = Brightbox::BBConfig.new
 
@@ -33,6 +31,6 @@ module ConfigHelpers
   #
   def config_file_contents
     config = Brightbox::BBConfig.new
-    IO.read(config.config_filename)
+    File.read(config.config_filename)
   end
 end

data/spec/support/password_prompt_helpers.rb

@@ -6,10 +6,31 @@ module PasswordPromptHelpers
     "N:B3e%7Cmh"
   end
 
+  # Intercepts HighLine prompts for a one-time password (OTP) used as part of
+  # two factor authentication (2FA). The prevents blocking the spec waiting for
+  # input.
+  #
+  def mock_otp_entry(otp = "123456")
+    input = instance_double(HighLine)
+
+    expect(input).to receive(:ask).with("Enter your two factor pin : ")
+                                  .once
+                                  .and_return(otp)
+
+    expect(HighLine).to receive(:new).once.and_return(input)
+  end
+
   # Intercepts HighLine prompting for a password and returns the testing default
   # or a specific value. Otherwise this blocks the specs.
   #
   def mock_password_entry(password = default_test_password)
-    expect_any_instance_of(HighLine).to receive(:ask).at_least(:once).and_return(password)
+    input = instance_double(HighLine)
+
+    allow(input).to receive(:say).with("Your API credentials have expired, enter your password to update them.")
+    expect(input).to receive(:ask).with("Enter your password : ")
+                                  .once
+                                  .and_return(password)
+
+    expect(HighLine).to receive(:new).once.and_return(input)
   end
 end

data/spec/support/server_helper.rb

@@ -3,11 +3,11 @@
 module ServerHelpers
   def server_params(name, _type = nil)
     {
-      :image_id      => "img-12345",
-      :name          => name,
-      :zone_id       => nil.to_s,
-      :flavor_id     => "typ-12345",
-      :user_data     => nil
+      :image_id => "img-12345",
+      :name => name,
+      :zone_id => nil.to_s,
+      :flavor_id => "typ-12345",
+      :user_data => nil
     }
   end
 end

data/spec/support/tmp_config.rb

@@ -7,6 +7,7 @@ require "fileutils"
 #
 class TmpConfig
   attr_reader :path
+
   # Creates a temporary directory and a "config" file within using the contents
   # of a passed String.
   #
@@ -19,7 +20,6 @@ class TmpConfig
     @file = File.open(File.join(@path, "config"), "w+")
     @file.write(contents)
     @file.close
-    self
   end
 
   def close

data/spec/support/token_helpers.rb

@@ -3,12 +3,12 @@ require "securerandom"
 module TokenHelpers
   # Creates a cached access token for the config directly to disk
   def cache_access_token(config, token)
-    File.open(config.access_token_filename, "w") { |f| f.write token }
+    File.write(config.access_token_filename, token)
   end
 
   # Creates a cached refresh token for the config directly to disk
   def cache_refresh_token(config, token)
-    File.open(config.refresh_token_filename, "w") { |f| f.write token }
+    File.write(config.refresh_token_filename, token)
   end
 
   # Returns the cached access token for the config directly from disk

data/spec/support/vcr.rb

@@ -8,8 +8,8 @@ VCR.configure do |vcr|
   vcr.configure_rspec_metadata!
   vcr.default_cassette_options = {
     :record => :none,
-    #:record => :new_episodes,
-    :match_requests_on => [:method, :path, :body],
+    # :record => :new_episodes,
+    :match_requests_on => %i[method path body],
     :update_content_length_header => true
   }
 
@@ -18,25 +18,6 @@ VCR.configure do |vcr|
 
   vcr.before_record do |interaction|
     host = URI.parse(interaction.request.uri).host
-    interaction.request.uri.gsub!(host, "api.brightbox.dev")
-
-    # Sanitise identifiers as best as we can
-    # We need the poser of Regexp so filter_sensitive doesn't help
-    %w(acc col cip fwp fwr grp img lba srv typ usr zon).each do |prefix|
-      id_pattern = /#{prefix}-[0-9a-z]+/
-      interaction.request.uri.gsub!(id_pattern, "#{prefix}-12345")
-      interaction.request.body.gsub!(id_pattern, "#{prefix}-12345")
-      interaction.response.body.gsub!(id_pattern, "#{prefix}-12345")
-    end
+    interaction.request.uri.gsub!(host, "api.brightbox.localhost")
   end
 end
-
-VCR.turn_off!
-
-VCR.extend Module.new {
-  def use_cassette(*args)
-    VCR.turn_on!
-    super
-    VCR.turn_off!
-  end
-}

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

@@ -4,8 +4,8 @@ describe Brightbox::Api, "#created_on" do
   subject(:api_model) { described_class.new(fog_model) }
   let(:fog_model) do
     double id: nil,
-          attributes: attrs,
-          created_at: attrs[:created_at]
+           attributes: attrs,
+           created_at: attrs[:created_at]
   end
 
   context "when initialised with no attributes" do

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

@@ -1,29 +1,29 @@
 require "spec_helper"
 
 describe Brightbox::Api, "#fog_model" do
+  let(:fog_model) { Fog::Model.new }
+  let(:identifier) { "api-12345" }
+
+  before do
+    allow(fog_model).to receive(:id).and_return(identifier)
+    allow(fog_model).to receive(:attributes).and_return({})
+  end
 
   context "when initialised with a fog model" do
-    before do
-      @identifier = "api-12345"
-      @fog_model = double
-      expect(@fog_model).to receive(:id).and_return(@identifier)
-      allow(@fog_model).to receive(:attributes).and_return({})
-    end
+    subject(:instance) { described_class.new(fog_model) }
 
     it "returns the object" do
-      @api_instance = Brightbox::Api.new(@fog_model)
-      expect(@api_instance.fog_model).to eql(@fog_model)
+      expect(instance.fog_model).to eql(fog_model)
     end
   end
 
   context "when initialised with an identifier string" do
+    subject(:instance) { described_class.new(identifier) }
+
     it "attempts to find a resource" do
-      @identifier = "api-12345"
-      @fog_model = double
+      expect(Brightbox::Api).to receive(:find).with(identifier).and_return(fog_model)
 
-      @api_instance = Brightbox::Api.new(@identifier)
-      expect(Brightbox::Api).to receive(:find).with(@identifier).and_return(@fog_model)
-      expect(@api_instance.fog_model).to eql(@fog_model)
+      expect(instance.fog_model).to eql(fog_model)
     end
   end
 end

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

@@ -1,7 +1,6 @@
 require "spec_helper"
 
 describe Brightbox::Api, ".klass_name" do
-
   context "when called on abstract class" do
     it "returns 'Api' as string" do
       expect(Brightbox::Api.klass_name).to eq("Api")

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

@@ -0,0 +1,64 @@
+require "ostruct"
+require "spec_helper"
+
+RSpec.describe Brightbox::Api, "#method_missing" do
+  let(:fog_model) { Fog::Model.new }
+  let(:identifier) { "api-12345" }
+
+  before do
+    allow(fog_model).to receive(:id).and_return(identifier)
+    allow(fog_model).to receive(:attributes).and_return({})
+  end
+
+  context "when initialised with a fog model" do
+    subject(:instance) { described_class.new(fog_model) }
+
+    context "with a top level method" do
+      it do
+        expect(instance.to_s).to eq(identifier)
+      end
+    end
+
+    context "with a delegated method" do
+      let(:method_name) { :attributes }
+
+      it do
+        expect(instance.attributes).to eq({})
+      end
+    end
+
+    context "with unknown method" do
+      it do
+        expect { instance.onions }.to raise_error(NoMethodError)
+      end
+    end
+  end
+
+  context "when initialised with an identifier string" do
+    subject(:instance) { described_class.new(identifier) }
+
+    before do
+      allow(Brightbox::Api).to receive(:find).with(identifier).and_return(fog_model)
+    end
+
+    context "with a top level method" do
+      it do
+        expect(instance.to_s).to eq(identifier)
+      end
+    end
+
+    context "with a delegated method" do
+      let(:method_name) { :attributes }
+
+      it do
+        expect(instance.attributes).to eq({})
+      end
+    end
+
+    context "with unknown method" do
+      it do
+        expect { instance.onions }.to raise_error(NoMethodError)
+      end
+    end
+  end
+end

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

@@ -1,7 +1,6 @@
 require "spec_helper"
 
 describe Brightbox::Api, ".require_account?" do
-
   context "when on abstract class" do
     it "returns false" do
       expect(Brightbox::Api.require_account?).to be false

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

@@ -0,0 +1,71 @@
+require "spec_helper"
+
+RSpec.describe Brightbox::Api, "#respond_to?" do
+  let(:fog_model) { Fog::Model.new }
+  let(:identifier) { "api-12345" }
+
+  before do
+    allow(fog_model).to receive(:id).and_return(identifier)
+    allow(fog_model).to receive(:attributes).and_return({})
+  end
+
+  context "when initialised with a fog model" do
+    subject(:instance) { described_class.new(fog_model) }
+
+    context "with a top level method" do
+      let(:method_name) { :to_s }
+
+      it do
+        expect(instance.respond_to?(method_name)).to be(true)
+      end
+    end
+
+    context "with a delegated method" do
+      let(:method_name) { :attributes }
+
+      it do
+        expect(instance.respond_to?(method_name)).to be(true)
+      end
+    end
+
+    context "with unknown method" do
+      let(:method_name) { :onions }
+
+      it do
+        expect(instance.respond_to?(method_name)).to be(false)
+      end
+    end
+  end
+
+  context "when initialised with an identifier string" do
+    subject(:instance) { described_class.new(identifier) }
+
+    before do
+      allow(Brightbox::Api).to receive(:find).with(identifier).and_return(fog_model)
+    end
+
+    context "with a top level method" do
+      let(:method_name) { :to_s }
+
+      it do
+        expect(instance.respond_to?(method_name)).to be(true)
+      end
+    end
+
+    context "with a delegated method" do
+      let(:method_name) { :attributes }
+
+      it do
+        expect(instance.respond_to?(method_name)).to be(true)
+      end
+    end
+
+    context "with unknown method" do
+      let(:method_name) { :onions }
+
+      it do
+        expect(instance.respond_to?(method_name)).to be(false)
+      end
+    end
+  end
+end

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

@@ -1,7 +1,6 @@
 require "spec_helper"
 
 describe Brightbox::BBConfig do
-
   describe "#access_token_filename" do
     context "when using a custom directory" do
       before do

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

@@ -1,7 +1,6 @@
 require "spec_helper"
 
 describe Brightbox::BBConfig do
-
   describe "#account" do
     context "when passed as an option" do
       before do

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

@@ -5,21 +5,21 @@ describe Brightbox::BBConfig, "#add_login" do
 
   let(:email) { "jason.null@brightbox.com" }
   let(:password) { "N:B3e%7Cmh" }
-  let(:api_url) { ENV["BRIGHTBOX_API_URL"] || "http://api.brightbox.dev" }
+  let(:api_url) { Brightbox::DEFAULT_API_ENDPOINT }
 
   context "when no config exists", vcr: true do
     let(:expected_config) do
-      <<EOS
-[core]
-default_client = #{email}
+      <<~EOS
+        [core]
+        default_client = #{email}
 
-[#{email}]
-username = #{email}
-api_url = #{api_url}
-auth_url = #{api_url}
-default_account = acc-12345
+        [#{email}]
+        username = #{email}
+        api_url = #{api_url}
+        auth_url = #{api_url}
+        default_account = acc-12345
 
-EOS
+      EOS
     end
 
     before do
@@ -52,9 +52,9 @@ EOS
 
     it "does not alter the configuration" do
       FauxIO.new do
-        expect {
+        expect do
           config.add_login(email, password)
-        }.not_to change { config_file_contents }.from(original_config)
+        end.not_to change { config_file_contents }.from(original_config)
       end
     end
 
@@ -78,7 +78,7 @@ EOS
   context "when configured with custom options", vcr: true do
     let(:original_config) { config_file_contents }
 
-    let(:custom_url) { ENV["BRIGHTBOX_API_URL"] || "http://api.brightbox.dev" }
+    let(:custom_url) { Brightbox::DEFAULT_API_ENDPOINT }
     let(:custom_app_id) { "app-23456" }
     let(:custom_app_secret) { "ho04hondtzjjdf4" }
     let(:custom_default_account) { "acc-23456" }
@@ -99,9 +99,9 @@ EOS
 
     it "does not alter the configuration" do
       FauxIO.new do
-        expect {
+        expect do
           config.add_login(email, password)
-        }.not_to change { config_file_contents }.from(original_config)
+        end.not_to change { config_file_contents }.from(original_config)
       end
 
       expect(config_file_contents).to match("[#{email}]")
@@ -132,7 +132,7 @@ EOS
   context "when altering a custom option", vcr: true do
     let(:original_config) { config_file_contents }
 
-    let(:custom_url) { ENV["BRIGHTBOX_API_URL"] || "http://api.brightbox.dev" }
+    let(:custom_url) { Brightbox::DEFAULT_API_ENDPOINT }
     let(:custom_app_id) { "app-23456" }
     let(:custom_app_secret) { "ho04hondtzjjdf4" }
     let(:custom_default_account) { "acc-23456" }
@@ -153,9 +153,9 @@ EOS
 
     it "does not alter the configuration" do
       FauxIO.new do
-        expect {
+        expect do
           config.add_login(email, password)
-        }.not_to change { config_file_contents }.from(original_config)
+        end.not_to change { config_file_contents }.from(original_config)
       end
 
       expect(config_file_contents).to match("[#{email}]")
@@ -185,17 +185,17 @@ EOS
   context "when using an email and suffix", vcr: true do
     let(:client_name) { "#{email}/dev" }
     let(:expected_config) do
-      <<EOS
-[core]
-default_client = #{client_name}
+      <<~EOS
+        [core]
+        default_client = #{client_name}
 
-[#{client_name}]
-username = #{email}
-api_url = #{api_url}
-auth_url = #{api_url}
-default_account = acc-12345
+        [#{client_name}]
+        username = #{email}
+        api_url = #{api_url}
+        auth_url = #{api_url}
+        default_account = acc-12345
 
-EOS
+      EOS
     end
 
     before do
@@ -218,5 +218,4 @@ EOS
       expect(cached_refresh_token(config)).to eq(config.refresh_token)
     end
   end
-
 end

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

@@ -1,7 +1,6 @@
 require "spec_helper"
 
 describe Brightbox::BBConfig do
-
   describe "#add_section" do
     context "when first and only client", vcr: true do
       let(:config) { Brightbox::BBConfig.new }
@@ -12,7 +11,7 @@ describe Brightbox::BBConfig do
       let(:options) do
         {
           :username => "jason.null@brightbox.com",
-          :api_url => "http://api.brightbox.dev"
+          :api_url => "http://api.brightbox.localhost"
         }
       end
       let(:saved_config) { config_file_contents }