brightbox-cli 4.2.0 → 4.3.0

data/locales/en.yml

@@ -136,6 +136,8 @@ en:
     update:
       desc: Update a load balancer
       long_desc: All intervals and timeouts are in milliseconds
+  login:
+    desc: Authenticate using an email address
   servers:
     desc: Manage an account's servers
     activate_console:
@@ -153,7 +155,7 @@ en:
     reboot:
       desc: Reboot servers (OS reboot issued)
     reset:
-      desc: Reset servers (Hardward reset issued)
+      desc: Reset servers (Hardware reset issued)
     show:
       desc: Show servers
     shutdown:
@@ -243,3 +245,59 @@ en:
       desc: Show users
     update:
       desc: Update a user
+  volumes:
+    desc: Manage an account's volumes
+    args:
+      one: <volume>
+      optional: [<volume>...]
+      many: <volume>...
+      specify_one_id_first: You must specify the volume ID as the first argument
+      specify_many_ids: You must specify volume IDs as arguments
+      unknown_id: Couldn't find %{volume}
+    options:
+      boot: Set this volume as boot volume on server
+      delete_with_server: Set volume to be deleted with a server if attached
+      encrypted: Encrypt the volume
+      fs_label: Filesystem label, visible from within some OS
+      fs_type: Filesystem type to use to create blank volume
+      image: Create volume from existing Image ID
+      serial: Customisable serial number for volume
+      size: Volume size in MB
+    attach:
+      desc: Attach a volume to an existing server
+      args: <volume> <server>
+      specify_server_id_second: "You must specify the server ID to attach to as the second argument"
+      acting: Attaching %{volume}
+    copy:
+      desc: Create a new volume from an existing one
+      acting: Copying %{volume}
+    create:
+      desc: Create a new volume
+      acting: Creating volume
+      image_or_type_required: An 'image' or 'fs-type' option must be passed
+      either_image_or_type: An 'image' and 'fs-type' can not be passed together
+    destroy:
+      desc: Destroy one or more volumes
+      acting: Destroying %{volume}
+    detach:
+      desc: Detach a volume from a server
+      acting: Detaching %{volume}
+    list:
+      desc: List all volumes or limit using passed IDs
+    lock:
+      desc: Lock volumes
+      acting: Locking %{volume}
+    resize:
+      desc: Resize a volume
+      size_option_needed: A 'size' option is required
+      acting: Resizing %{volume}
+    show:
+      desc: Show details about multiple volumes
+    unlock:
+      desc: Unlock volumes
+      acting: Unlocking %{volume}
+    update:
+      desc: Update a volume
+      acting: Updating %{volume}
+
+

data/spec/commands/volumes/attach_spec.rb

@@ -0,0 +1,165 @@
+require "spec_helper"
+
+describe "brightbox volumes attach" do
+  include VolumeHelpers
+
+  let(:output) { FauxIO.new { Brightbox.run(argv) } }
+  let(:stdout) { output.stdout }
+  let(:stderr) { output.stderr }
+
+  before do
+    config_from_contents(API_CLIENT_CONFIG_CONTENTS)
+
+    stub_request(:post, "http://api.brightbox.localhost/token")
+      .to_return(
+        status: 200,
+        body: JSON.dump(
+          access_token: "ACCESS-TOKEN",
+          refresh_token: "REFRESH_TOKEN"
+        )
+      )
+
+    Brightbox.config.reauthenticate
+  end
+
+  context "without arguments" do
+    let(:argv) { %w[volumes attach] }
+
+    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(stdout).to match("")
+    end
+  end
+
+  context "without server arguments" do
+    let(:argv) { %w[volumes attach vol-32145] }
+
+    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(stdout).to match("")
+    end
+  end
+
+  context "with arguments" do
+    let(:argv) { %w[volumes attach vol-809s1 srv-03431] }
+
+    before do
+      stub_request(:get, "http://api.brightbox.localhost/1.0/volumes/vol-809s1")
+        .with(query: hash_including(account_id: "acc-12345"))
+        .to_return(
+          status: 200,
+          body: volume_response(
+            id: "vol-809s1",
+            status: "detached",
+            boot: false,
+            server: nil
+          )
+        )
+        .to_return(
+          status: 200,
+          body: volume_response(
+            id: "vol-809s1",
+            status: "attached",
+            boot: false,
+            server: {
+              id: "srv-03431"
+            }
+          )
+        )
+
+      stub_request(:post, "http://api.brightbox.localhost/1.0/volumes/vol-809s1/attach")
+        .with(query: hash_including(account_id: "acc-12345"),
+              body: hash_including(
+                server: "srv-03431",
+                boot: false
+              ))
+        .to_return(
+          status: 202,
+          body: volume_response(
+            id: "vol-809s1",
+            status: "attached",
+            server: {
+              id: "srv-03431"
+            }
+          )
+        )
+    end
+
+    it "does not error" do
+      expect { output }.to_not raise_error
+
+      expect(stderr).to eq("Attaching vol-809s1\n")
+
+      aggregate_failures do
+        expect(stdout).to match("vol-809s1")
+        expect(stdout).to match("attached")
+        expect(stdout).to match("false")
+      end
+    end
+  end
+
+  context "with boot option" do
+    let(:argv) { %w[volumes attach --boot vol-90328 srv-03431] }
+
+    before do
+      stub_request(:get, "http://api.brightbox.localhost/1.0/volumes/vol-90328")
+      .with(query: hash_including(account_id: "acc-12345"))
+      .to_return(
+        status: 200,
+        body: volume_response(
+          id: "vol-90328",
+          status: "detached",
+          boot: false,
+          server: nil
+        )
+      )
+      .to_return(
+        status: 200,
+        body: volume_response(
+          id: "vol-90328",
+          status: "attached",
+          boot: true,
+          server: {
+            id: "srv-03431"
+          }
+        )
+      )
+
+      stub_request(:post, "http://api.brightbox.localhost/1.0/volumes/vol-90328/attach")
+        .with(query: hash_including(account_id: "acc-12345"),
+              body: hash_including(
+                server: "srv-03431",
+                boot: true
+              ))
+        .to_return(
+          status: 202,
+          body: volume_response(
+            id: "vol-90328",
+            boot: true,
+            status: "attached",
+            server: {
+              id: "srv-03431"
+            }
+          )
+        )
+    end
+
+    it "does not error" do
+      expect { output }.to_not raise_error
+
+      expect(stderr).to eq("Attaching vol-90328\n")
+
+      aggregate_failures do
+        expect(stdout).to match("vol-90328")
+        expect(stdout).to match("attached")
+        expect(stdout).to match("true")
+      end
+    end
+  end
+end

data/spec/commands/volumes/copy_spec.rb

@@ -0,0 +1,74 @@
+require "spec_helper"
+
+describe "brightbox volumes copy" do
+  include VolumeHelpers
+
+  let(:output) { FauxIO.new { Brightbox.run(argv) } }
+  let(:stdout) { output.stdout }
+  let(:stderr) { output.stderr }
+
+  before do
+    config_from_contents(API_CLIENT_CONFIG_CONTENTS)
+
+    stub_request(:post, "http://api.brightbox.localhost/token")
+      .to_return(
+        status: 200,
+        body: JSON.dump(
+          access_token: "ACCESS-TOKEN",
+          refresh_token: "REFRESH_TOKEN"
+        )
+      )
+
+    Brightbox.config.reauthenticate
+  end
+
+  context "without arguments" do
+    let(:argv) { %w[volumes copy] }
+
+    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(stdout).to match("")
+    end
+  end
+
+  context "with argument" do
+    let(:argv) { %w[volumes copy vol-909ds] }
+
+    before do
+      stub_request(:get, "http://api.brightbox.localhost/1.0/volumes/vol-909ds")
+      .with(query: hash_including(account_id: "acc-12345"))
+      .to_return(
+        status: 200,
+        body: volume_response(
+          id: "vol-909ds"
+        )
+      )
+      .to_return(
+        status: 200,
+        body: volume_response(
+          id: "vol-909ds"
+        )
+      )
+
+      stub_request(:post, "http://api.brightbox.localhost/1.0/volumes/vol-909ds/copy")
+        .with(query: hash_including(account_id: "acc-12345"))
+        .to_return(
+          status: 202,
+          body: volume_response(
+            id: "vol-909ds"
+          )
+        )
+    end
+
+    it "does not error" do
+      expect { output }.to_not raise_error
+
+      expect(stderr).to eq("Copying vol-909ds\n")
+
+      expect(stdout).to match("vol-909ds")
+    end
+  end
+end

data/spec/commands/volumes/create_spec.rb

@@ -0,0 +1,217 @@
+require "spec_helper"
+
+describe "brightbox volumes create" do
+  include VolumeHelpers
+
+  let(:output) { FauxIO.new { Brightbox.run(argv) } }
+  let(:stdout) { output.stdout }
+  let(:stderr) { output.stderr }
+
+  let(:token) { SecureRandom.hex }
+
+  before do
+    config_from_contents(API_CLIENT_CONFIG_CONTENTS)
+
+    stub_request(:post, "http://api.brightbox.localhost/token")
+      .to_return(status: 200, body: JSON.dump(access_token: token))
+
+    Brightbox.config.reauthenticate
+  end
+
+  context "without options" do
+    let(:argv) { %w[volumes create] }
+
+    it "does not error" do
+      expect { output }.to_not raise_error
+
+      expect(stderr).to match("ERROR: An 'image' or 'fs-type' option must be passed")
+
+      expect(stdout).to eq("")
+    end
+  end
+
+  context "with mutually exclusive options" do
+    let(:argv) { %w[volumes create --image img-12345 --fs-type ext4] }
+
+    it "does not error" do
+      expect { output }.to_not raise_error
+
+      expect(stderr).to match("ERROR: An 'image' and 'fs-type' can not be passed together")
+
+      expect(stdout).to eq("")
+    end
+  end
+
+  context "with image identifier" do
+    let(:argv) { %w[volumes create --image img-12345] }
+
+    before do
+      stub_request(:post, "http://api.brightbox.localhost/1.0/volumes")
+        .with(headers: { "Content-Type" => "application/json" },
+              query: hash_including(account_id: "acc-12345"),
+              body: {
+                delete_with_server: false,
+                encrypted: false,
+                image: "img-12345"
+              })
+        .to_return(
+          status: 202,
+          body: volume_response(
+            id: "vol-12345",
+            storage_type: "network",
+            size: 10_240,
+            status: "detached"
+          )
+        )
+    end
+
+    it "does not error" do
+      expect { output }.to_not raise_error
+
+      expect(stderr).not_to match("ERROR")
+
+      aggregate_failures do
+        expect(stdout).to match("id.*type.*size.*status.*server.*boot")
+
+        expect(stdout).to match("vol-12345")
+        expect(stdout).to match("network")
+        expect(stdout).to match("10240")
+        expect(stdout).to match("detached")
+        expect(stdout).to match("false")
+      end
+    end
+  end
+
+  context "with image and size" do
+    let(:argv) { %w[volumes create --image img-12345 --size 20480] }
+
+    before do
+      stub_request(:post, "http://api.brightbox.localhost/1.0/volumes")
+        .with(headers: { "Content-Type" => "application/json" },
+              query: hash_including(account_id: "acc-12345"),
+              body: {
+                delete_with_server: false,
+                encrypted: false,
+                image: "img-12345",
+                size: 20_480
+              })
+        .to_return(
+          status: 202,
+          body: volume_response(
+            id: "vol-12345",
+            storage_type: "network",
+            size: 20_480,
+            status: "detached"
+          )
+        )
+    end
+
+    it "does not error" do
+      expect { output }.to_not raise_error
+
+      expect(stderr).not_to match("ERROR")
+
+      aggregate_failures do
+        expect(stdout).to match("id.*type.*size.*status.*server.*boot")
+
+        expect(stdout).to match("vol-12345")
+        expect(stdout).to match("network")
+        expect(stdout).to match("20480")
+        expect(stdout).to match("detached")
+        expect(stdout).to match("false")
+      end
+    end
+  end
+
+  context "with filesystem type" do
+    let(:argv) { %w[volumes create --fs-type ext4] }
+
+    before do
+      stub_request(:post, "http://api.brightbox.localhost/1.0/volumes")
+        .with(headers: { "Content-Type" => "application/json" },
+              query: hash_including(account_id: "acc-12345"),
+              body: {
+                delete_with_server: false,
+                encrypted: false,
+                filesystem_type: "ext4"
+              })
+        .to_return(
+          status: 202,
+          body: volume_response(
+            id: "vol-12345",
+            storage_type: "network",
+            size: 10_240,
+            status: "detached"
+          )
+        )
+    end
+
+    it "does not error" do
+      expect { output }.to_not raise_error
+
+      expect(stderr).not_to match("ERROR")
+
+      aggregate_failures do
+        expect(stdout).to match("id.*type.*size.*status.*server.*boot")
+
+        expect(stdout).to match("vol-12345")
+        expect(stdout).to match("network")
+        expect(stdout).to match("10240")
+        expect(stdout).to match("detached")
+        expect(stdout).to match("false")
+      end
+    end
+  end
+
+  context "with most options" do
+          let(:argv) do
+            %w[volumes create --fs-label fnord --fs-type ext4 --delete-with-server --encrypted --name Nom -d Test --serial 12345 -s 20480]
+          end
+
+    before do
+      stub_request(:post, "http://api.brightbox.localhost/1.0/volumes")
+        .with(headers: { "Content-Type" => "application/json" },
+              query: hash_including(account_id: "acc-12345"),
+              body: {
+                delete_with_server: true,
+                description: "Test",
+                encrypted: true,
+                filesystem_label: "fnord",
+                filesystem_type: "ext4",
+                name: "Nom",
+                serial: "12345",
+                size: 20_480
+              })
+        .to_return(
+          status: 202,
+          body: volume_response(
+            id: "vol-43251",
+            name: "Nom",
+            boot: false,
+            description: "Test",
+            encrypted: true,
+            serial: "12345",
+            storage_type: "network",
+            size: 20_480,
+            status: "detached"
+          )
+        )
+    end
+
+    it "does not error" do
+      expect { output }.to_not raise_error
+
+      expect(stderr).not_to match("ERROR")
+
+      aggregate_failures do
+        expect(stdout).to match("id.*type.*size.*status.*server.*boot")
+
+        expect(stdout).to match("vol-43251")
+        expect(stdout).to match("network")
+        expect(stdout).to match("20480")
+        expect(stdout).to match("detached")
+        expect(stdout).to match("false")
+      end
+    end
+  end
+end

data/spec/commands/volumes/destroy_spec.rb

@@ -0,0 +1,173 @@
+require "spec_helper"
+
+describe "brightbox volumes destroy" do
+  include VolumeHelpers
+
+  let(:output) { FauxIO.new { Brightbox.run(argv) } }
+  let(:stdout) { output.stdout }
+  let(:stderr) { output.stderr }
+
+  before do
+    config_from_contents(API_CLIENT_CONFIG_CONTENTS)
+
+    stub_request(:post, "http://api.brightbox.localhost/token")
+      .to_return(
+        status: 200,
+        body: JSON.dump(
+          access_token: "ACCESS-TOKEN",
+          refresh_token: "REFRESH_TOKEN"
+        )
+      )
+
+    Brightbox.config.reauthenticate
+  end
+
+  context "without arguments" do
+    let(:argv) { %w[volumes destroy] }
+
+    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(stdout).to match("")
+    end
+  end
+
+  context "with one argument" do
+    let(:argv) { %w[volumes destroy vol-ui342] }
+
+    before do
+      stub_request(:get, "http://api.brightbox.localhost/1.0/volumes/vol-ui342")
+        .with(query: hash_including(account_id: "acc-12345"))
+        .to_return(
+          status: 200,
+          body: volume_response(
+            id: "vol-ui342",
+            status: "detached",
+            boot: false,
+            server: {
+              id: "srv-03431"
+            }
+          )
+        )
+        .to_return(
+          status: 200,
+          body: volume_response(
+            id: "vol-ui342",
+            status: "detached",
+            boot: false,
+            server: nil
+          )
+        )
+
+      stub_request(:delete, "http://api.brightbox.localhost/1.0/volumes/vol-ui342")
+        .with(query: hash_including(account_id: "acc-12345"))
+        .to_return(
+          status: 202,
+          body: volume_response(
+            id: "vol-ui342",
+            status: "detached",
+            server: {
+              id: "srv-03431"
+            }
+          )
+        )
+    end
+
+    it "does not error" do
+      expect { output }.to_not raise_error
+
+      expect(stderr).to match("Destroying vol-ui342\n")
+
+      expect(stdout).to eq("")
+    end
+  end
+
+  context "with multiple arguments" do
+    let(:argv) { %w[volumes destroy vol-o2342 vol-3422f] }
+
+    before do
+      stub_request(:get, "http://api.brightbox.localhost/1.0/volumes/vol-o2342")
+        .with(query: hash_including(account_id: "acc-12345"))
+        .to_return(
+          status: 200,
+          body: volume_response(
+            id: "vol-o2342",
+            status: "detached",
+            boot: false,
+            server: {
+              id: "srv-03431"
+            }
+          )
+        )
+        .to_return(
+          status: 200,
+          body: volume_response(
+            id: "vol-o2342",
+            status: "detached",
+            boot: false,
+            server: nil
+          )
+        )
+
+      stub_request(:delete, "http://api.brightbox.localhost/1.0/volumes/vol-o2342")
+        .with(query: hash_including(account_id: "acc-12345"))
+        .to_return(
+          status: 202,
+          body: volume_response(
+            id: "vol-o2342",
+            status: "detached",
+            server: {
+              id: "srv-03431"
+            }
+          )
+        )
+
+        stub_request(:get, "http://api.brightbox.localhost/1.0/volumes/vol-3422f")
+        .with(query: hash_including(account_id: "acc-12345"))
+        .to_return(
+          status: 200,
+          body: volume_response(
+            id: "vol-3422f",
+            status: "detached",
+            boot: false,
+            server: {
+              id: "srv-03431"
+            }
+          )
+        )
+        .to_return(
+          status: 200,
+          body: volume_response(
+            id: "vol-3422f",
+            status: "detached",
+            boot: false,
+            server: nil
+          )
+        )
+
+      stub_request(:delete, "http://api.brightbox.localhost/1.0/volumes/vol-3422f")
+        .with(query: hash_including(account_id: "acc-12345"))
+        .to_return(
+          status: 202,
+          body: volume_response(
+            id: "vol-3422f",
+            status: "detached",
+            server: {
+              id: "srv-03431"
+            }
+          )
+        )
+    end
+
+    it "does not error" do
+      expect { output }.to_not raise_error
+
+      expect(stderr).to match("Destroying vol-o2342\n")
+      expect(stderr).to match("Destroying vol-3422f\n")
+
+      expect(stdout).to eq("")
+    end
+  end
+end