knife-ionoscloud 6.0.0.alpha.1 → 6.1.0

data/lib/chef/knife/ionoscloud_user_create.rb

@@ -36,19 +36,19 @@ class Chef
               long: '--sec-auth',
               description: 'Indicates if secure (two-factor) authentication should be forced for the user.'
 
-      attr_reader :description, :required_options
-
       def initialize(args = [])
         super(args)
         @description =
         'Creates a new user under a particular contract. **Please Note**: The password set '\
         'here cannot be updated through the API currently. It is recommended that a new user '\
         'log into the DCD and change their password.'
+        @directory = 'user'
         @required_options = [:firstname, :lastname, :email, :password, :ionoscloud_username, :ionoscloud_password]
       end
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         print "#{ui.color('Creating user...', :magenta)}"
@@ -69,14 +69,7 @@ class Chef
         dot = ui.color('.', :magenta)
         api_client.wait_for { print dot; is_done? get_request_id headers }
 
-        puts "\n"
-        puts "#{ui.color('ID', :cyan)}: #{user.id}"
-        puts "#{ui.color('Firstname', :cyan)}: #{user.properties.firstname}"
-        puts "#{ui.color('Lastname', :cyan)}: #{user.properties.lastname}"
-        puts "#{ui.color('Email', :cyan)}: #{user.properties.email}"
-        puts "#{ui.color('Administrator', :cyan)}: #{user.properties.administrator.to_s}"
-        puts "#{ui.color('2-Factor Auth', :cyan)}: #{user.properties.force_sec_auth.to_s}"
-        puts 'done'
+        print_user(user)
       end
     end
   end

data/lib/chef/knife/ionoscloud_user_delete.rb

@@ -7,19 +7,19 @@ class Chef
 
       banner 'knife ionoscloud user delete USER_ID [USER_ID]'
 
-      attr_reader :description, :required_options
-
       def initialize(args = [])
         super(args)
         @description =
         'Blacklists the user, disabling them. The user is not completely purged, '\
         'therefore if you anticipate needing to create a user with the same name '\
         'in the future, we suggest renaming the user before you delete it.'
+        @directory = 'user'
         @required_options = [:ionoscloud_username, :ionoscloud_password]
       end
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         user_management_api = Ionoscloud::UserManagementApi.new(api_client)
@@ -33,12 +33,7 @@ class Chef
             next
           end
 
-          msg_pair('ID', user.id)
-          msg_pair('Firstname', user.properties.firstname)
-          msg_pair('Lastname', user.properties.lastname)
-          msg_pair('Email', user.properties.email)
-          msg_pair('Administrator', user.properties.administrator.to_s)
-          msg_pair('2-Factor Auth', user.properties.force_sec_auth.to_s)
+          print_user(user)
           puts "\n"
 
           begin

data/lib/chef/knife/ionoscloud_user_get.rb

@@ -0,0 +1,31 @@
+require_relative 'ionoscloud_base'
+
+class Chef
+  class Knife
+    class IonoscloudUserGet < Knife
+      include Knife::IonoscloudBase
+
+      banner 'knife ionoscloud user get (options)'
+
+      option :user_id,
+              short: '-U USER_ID',
+              long: '--user-id USER_ID',
+              description: 'ID of the group.'
+
+      def initialize(args = [])
+        super(args)
+        @description =
+        'Retrieves the attributes of a given Ionoscloud User.'
+        @directory = 'user'
+        @required_options = [:user_id, :ionoscloud_username, :ionoscloud_password]
+      end
+
+      def run
+        $stdout.sync = true
+        handle_extra_config
+        validate_required_params(@required_options, config)
+        print_user(Ionoscloud::UserManagementApi.new(api_client).um_users_find_by_id(config[:user_id]))
+      end
+    end
+  end
+end

data/lib/chef/knife/ionoscloud_user_list.rb

@@ -12,19 +12,19 @@ class Chef
               long: '--group-id GROUP_ID',
               description: 'ID of the group.'
 
-      attr_reader :description, :required_options
-
       def initialize(args = [])
         super(args)
         @description =
         'Retrieve a list of all the users that have been created under a contract. '\
         'You can retrieve a list of users who are members of the group by passing the '\
         '_group\_id_ option.'
+        @directory = 'user'
         @required_options = [:ionoscloud_username, :ionoscloud_password]
       end
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         user_list = [

data/lib/chef/knife/ionoscloud_user_ssourl.rb

@@ -12,17 +12,17 @@ class Chef
               long: '--user-id USER_ID',
               description: 'The ID of the Backup unit.'
 
-      attr_reader :description, :required_options
-
       def initialize(args = [])
         super(args)
         @description =
         'Retrieve S3 object storage single signon URL for the given user.'
+        @directory = 'user'
         @required_options = [:user_id, :ionoscloud_username, :ionoscloud_password]
       end
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         begin

data/lib/chef/knife/ionoscloud_user_update.rb

@@ -0,0 +1,91 @@
+require_relative 'ionoscloud_base'
+
+class Chef
+  class Knife
+    class IonoscloudUserUpdate < Knife
+      include Knife::IonoscloudBase
+
+      banner 'knife ionoscloud user update (options)'
+
+      option :user_id,
+              short: '-U USER_ID',
+              long: '--user-id USER_ID',
+              description: 'ID of the User.'
+
+      option :firstname,
+              short: '-f FIRSTNAME',
+              long: '--firstname FIRSTNAME',
+              description: 'Firstname of the user.'
+
+      option :lastname,
+              short: '-l LASTNAME',
+              long: '--lastname LASTNAME',
+              description: 'Lastname of the user.'
+
+      option :email,
+              long: '--email EMAIL',
+              description: 'An e-mail address for the user.'
+
+      option :administrator,
+              short: '-a ADMIN',
+              long: '--admin ADMIN',
+              description: 'Assigns the user have administrative rights.'
+
+      option :force_sec_auth,
+              long: '--sec-auth FORCE_SEC_AUTH',
+              description: 'Indicates if secure (two-factor) authentication should be forced for the user.'
+
+      option :sec_auth_active,
+              long: '--sec-auth SEC_AUTH_ACTIVE',
+              description: 'Indicates if secure authentication is active for the user or not.'
+
+      option :active,
+              long: '--active ACTIVE',
+              description: 'Indicates if the user is active.'
+
+      def initialize(args = [])
+        super(args)
+        @description =
+        'Updates information about a Ionoscloud User.'
+        @directory = 'user'
+        @required_options = [:user_id, :ionoscloud_username, :ionoscloud_password]
+        @updatable_fields = [:firstname, :lastname, :email, :administrator, :force_sec_auth, :sec_auth_active, :active]
+      end
+
+      def run
+        $stdout.sync = true
+        handle_extra_config
+        validate_required_params(@required_options, config)
+
+        user_management_api = Ionoscloud::UserManagementApi.new(api_client)
+
+        if @updatable_fields.map { |el| config[el] }.any?
+          print "#{ui.color('Updating User...', :magenta)}"
+
+          user = user_management_api.um_users_find_by_id(config[:user_id])
+
+          new_user = Ionoscloud::UserPut.new(
+            properties: Ionoscloud::UserPropertiesPut.new(
+              firstname: config[:firstname] || user.properties.firstname,
+              lastname: config[:lastname] || user.properties.lastname,
+              email: config[:email] || user.properties.email,
+              administrator: (config.key?(:administrator) ? config[:administrator].to_s.downcase == 'true' : user.properties.administrator),
+              force_sec_auth: (config.key?(:force_sec_auth) ? config[:force_sec_auth].to_s.downcase == 'true' : user.properties.force_sec_auth),
+              sec_auth_active: (config.key?(:sec_auth_active) ? config[:sec_auth_active].to_s.downcase == 'true' : user.properties.sec_auth_active),
+              active: (config.key?(:active) ? config[:active].to_s.downcase == 'true' : user.properties.active),
+            ),
+          )
+
+          _, _, headers  = user_management_api.um_users_put_with_http_info(config[:user_id], new_user)
+
+          dot = ui.color('.', :magenta)
+          api_client.wait_for { print dot; is_done? get_request_id headers }
+        else
+          ui.warn("Nothing to update, please set one of the attributes #{@updatable_fields}.")
+        end
+
+        print_user(user_management_api.um_users_find_by_id(config[:user_id]))
+      end
+    end
+  end
+end

data/lib/chef/knife/ionoscloud_volume_attach.rb

@@ -17,17 +17,17 @@ class Chef
               long: '--server-id SERVER_ID',
               description: 'The ID of the server'
 
-      attr_reader :description, :required_options
-
       def initialize(args = [])
         super(args)
         @description =
         'This will attach a pre-existing storage volume to the server.'
+        @directory = 'compute-engine'
         @required_options = [:datacenter_id, :server_id, :ionoscloud_username, :ionoscloud_password]
       end
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         server_api = Ionoscloud::ServersApi.new(api_client)

data/lib/chef/knife/ionoscloud_volume_create.rb

@@ -71,21 +71,21 @@ class Chef
               'immutable and is only allowed to be set on a new volume creation. It is mandatory to provide either \'public image\' '\
               'or \'imageAlias\' that has cloud-init compatibility in conjunction with this property.'
 
-      attr_reader :description, :required_options
-
       def initialize(args = [])
         super(args)
         @description =
         'Creates a volume within the data center. This will NOT attach the volume to a server. '\
         'Please see the Servers section for details on how to attach storage volumes.'
+        @directory = 'compute-engine'
         @required_options = [:datacenter_id, :name, :type, :size, :ionoscloud_username, :ionoscloud_password]
       end
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
-        config[:ssh_keys] = config[:ssh_keys].split(',') if config[:ssh_keys]
+        config[:ssh_keys] = config[:ssh_keys].split(',') if config[:ssh_keys] && config[:ssh_keys].instance_of?(String)
 
         print "#{ui.color('Creating volume...', :magenta)}"
 
@@ -113,18 +113,7 @@ class Chef
         dot = ui.color('.', :magenta)
         api_client.wait_for(300) { print dot; is_done? get_request_id headers }
 
-        volume = volume_api.datacenters_volumes_find_by_id(config[:datacenter_id], volume.id)
-
-        puts "\n"
-        puts "#{ui.color('ID', :cyan)}: #{volume.id}"
-        puts "#{ui.color('Name', :cyan)}: #{volume.properties.name}"
-        puts "#{ui.color('Size', :cyan)}: #{volume.properties.size}"
-        puts "#{ui.color('Bus', :cyan)}: #{volume.properties.bus}"
-        puts "#{ui.color('Image', :cyan)}: #{volume.properties.image}"
-        puts "#{ui.color('Type', :cyan)}: #{volume.properties.type}"
-        puts "#{ui.color('Licence Type', :cyan)}: #{volume.properties.licence_type}"
-        puts "#{ui.color('Zone', :cyan)}: #{volume.properties.availability_zone}"
-        puts 'done'
+        print_volume(volume_api.datacenters_volumes_find_by_id(config[:datacenter_id], volume.id))
       end
     end
   end

data/lib/chef/knife/ionoscloud_volume_delete.rb

@@ -12,18 +12,18 @@ class Chef
               long: '--datacenter-id DATACENTER_ID',
               description: 'Name of the data center'
 
-      attr_reader :description, :required_options
-
       def initialize(args = [])
         super(args)
         @description =
         'Deletes the specified volume. This will result in the volume being '\
         'removed from your virtual data center. Please use this with caution!'
+        @directory = 'compute-engine'
         @required_options = [:datacenter_id, :ionoscloud_username, :ionoscloud_password]
       end
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         volume_api = Ionoscloud::VolumesApi.new(api_client)
@@ -40,14 +40,8 @@ class Chef
             next
           end
 
-          msg_pair('ID', volume.id)
-          msg_pair('Name', volume.properties.name)
-          msg_pair('Size', volume.properties.size)
-          msg_pair('Bus', volume.properties.bus)
-          msg_pair('Image', volume.properties.image)
-          msg_pair('Type', volume.properties.type)
-          msg_pair('Licence Type', volume.properties.licence_type)
-          msg_pair('Zone', volume.properties.availability_zone)
+          print_volume(volume)
+          puts "\n"
 
           begin
             confirm('Do you really want to delete this volume')

data/lib/chef/knife/ionoscloud_volume_detach.rb

@@ -17,8 +17,6 @@ class Chef
               long: '--server-id SERVER_ID',
               description: 'The ID of the server'
 
-      attr_reader :description, :required_options
-
       def initialize(args = [])
         super(args)
         @description =
@@ -26,11 +24,13 @@ class Chef
         "HotUnplug settings, this may result in the server being rebooted.\n\n"\
         "This will NOT delete the volume from your virtual data center. You will "\
         "need to make a separate request to delete a volume."
+        @directory = 'compute-engine'
         @required_options = [:datacenter_id, :server_id, :ionoscloud_username, :ionoscloud_password]
       end
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         server_api = Ionoscloud::ServersApi.new(api_client)

data/lib/chef/knife/ionoscloud_volume_get.rb

@@ -0,0 +1,35 @@
+require_relative 'ionoscloud_base'
+
+class Chef
+  class Knife
+    class IonoscloudVolumeGet < Knife
+      include Knife::IonoscloudBase
+
+      banner 'knife ionoscloud volume get (options)'
+
+      option :datacenter_id,
+              short: '-D DATACENTER_ID',
+              long: '--datacenter-id DATACENTER_ID',
+              description: 'ID of the data center'
+
+      option :volume_id,
+              long: '--volume VOLUME_ID',
+              description: 'ID of the volume.'
+
+      def initialize(args = [])
+        super(args)
+        @description =
+        'Retrieves the attributes of a given Volume.'
+        @directory = 'compute-engine'
+        @required_options = [:datacenter_id, :volume_id, :ionoscloud_username, :ionoscloud_password]
+      end
+
+      def run
+        $stdout.sync = true
+        handle_extra_config
+        validate_required_params(@required_options, config)
+        print_volume(Ionoscloud::VolumesApi.new(api_client).datacenters_volumes_find_by_id(config[:datacenter_id], config[:volume_id]))
+      end
+    end
+  end
+end

data/lib/chef/knife/ionoscloud_volume_list.rb

@@ -17,18 +17,18 @@ class Chef
               long: '--server-id SERVER_ID',
               description: 'The ID of the server'
 
-      attr_reader :description, :required_options
-
       def initialize(args = [])
         super(args)
         @description =
         'List all available volumes under a data center. '\
         'You can also list all volumes attached to a specific server.'
+        @directory = 'compute-engine'
         @required_options = [:datacenter_id, :ionoscloud_username, :ionoscloud_password]
       end
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         volume_list = [

data/lib/chef/knife/ionoscloud_volume_update.rb

@@ -0,0 +1,105 @@
+require_relative 'ionoscloud_base'
+
+class Chef
+  class Knife
+    class IonoscloudVolumeUpdate < Knife
+      include Knife::IonoscloudBase
+
+      banner 'knife ionoscloud volume update (options)'
+
+      option :datacenter_id,
+              short: '-D DATACENTER_ID',
+              long: '--datacenter-id DATACENTER_ID',
+              description: 'Name of the data center'
+
+      option :volume_id,
+              long: '--volume VOLUME_ID',
+              description: 'ID of the Volume.'
+
+      option :name,
+              short: '-n NAME',
+              long: '--name NAME',
+              description: 'Name of the volume'
+
+      option :size,
+              short: '-S SIZE',
+              long: '--size SIZE',
+              description: 'The size of the volume in GB'
+
+      option :bus,
+              short: '-b BUS',
+              long: '--bus BUS',
+              description: 'The bus type of the volume (VIRTIO or IDE)'
+
+      option :cpu_hot_plug,
+              long: '--cpu-hot-plug CPU_HOT_PLUG',
+              description: 'The licence type of the volume (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      option :ram_hot_plug,
+              long: '--ram-hot-plug RAM_HOT_PLUG',
+              description: 'The licence type of the volume (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      option :nic_hot_plug,
+              long: '--nic-hot-plug NIC_HOT_PLUG',
+              description: 'The licence type of the volume (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      option :nic_hot_unplug,
+              long: '--nic-hot-unplug NIC_HOT_UNPLUG',
+              description: 'The licence type of the volume (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      option :disc_virtio_hot_plug,
+              long: '--disc-virtio-hot_plug DISC_VIRTIO_HOT_PLUG',
+              description: 'The licence type of the volume (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      option :disc_virtio_hot_unplug,
+              long: '--disc-virtio-hot_unplug DISC_VIRTIO_HOT_UNPLUG',
+              description: 'The licence type of the volume (LINUX, WINDOWS, UNKNOWN, OTHER)'
+
+      def initialize(args = [])
+        super(args)
+        @description =
+        'Updates information about a Ionoscloud Volume.'
+        @directory = 'compute-engine'
+        @required_options = [:datacenter_id, :volume_id, :ionoscloud_username, :ionoscloud_password]
+        @updatable_fields = [
+          :name, :size, :bus, :cpu_hot_plug, :ram_hot_plug, :nic_hot_plug, :nic_hot_unplug, :disc_virtio_hot_plug, :disc_virtio_hot_unplug,
+        ]
+      end
+
+      def run
+        $stdout.sync = true
+        handle_extra_config
+        validate_required_params(@required_options, config)
+
+        volume_api = Ionoscloud::VolumesApi.new(api_client)
+
+        if @updatable_fields.map { |el| config[el] }.any?
+          print "#{ui.color('Updating Volume...', :magenta)}"
+
+          _, _, headers  = volume_api.datacenters_volumes_patch_with_http_info(
+            config[:datacenter_id],
+            config[:volume_id],
+            Ionoscloud::VolumeProperties.new(
+              name: config[:name],
+              size: config[:size],
+              bus: config[:bus],
+              cpu_hot_plug: (config.key?(:cpu_hot_plug) ? config[:cpu_hot_plug].to_s.downcase == 'true' : nil),
+              ram_hot_plug: (config.key?(:ram_hot_plug) ? config[:ram_hot_plug].to_s.downcase == 'true' : nil),
+              nic_hot_plug: (config.key?(:nic_hot_plug) ? config[:nic_hot_plug].to_s.downcase == 'true' : nil),
+              nic_hot_unplug: (config.key?(:nic_hot_unplug) ? config[:nic_hot_unplug].to_s.downcase == 'true' : nil),
+              disc_virtio_hot_plug: (config.key?(:disc_virtio_hot_plug) ? config[:disc_virtio_hot_plug].to_s.downcase == 'true' : nil),
+              disc_virtio_hot_unplug: (config.key?(:disc_virtio_hot_unplug) ? config[:disc_virtio_hot_unplug].to_s.downcase == 'true' : nil),
+            ),
+          )
+
+          dot = ui.color('.', :magenta)
+          api_client.wait_for { print dot; is_done? get_request_id headers }
+        else
+          ui.warn("Nothing to update, please set one of the attributes #{@updatable_fields}.")
+        end
+
+        print_volume(volume_api.datacenters_volumes_find_by_id(config[:datacenter_id], config[:volume_id]))
+      end
+    end
+  end
+end

data/lib/knife-ionoscloud/version.rb

@@ -1,6 +1,6 @@
 module Knife
   module Ionoscloud
-    VERSION = '6.0.0.alpha.1'
+    VERSION = '6.1.0'
     MAJOR, MINOR, TINY = VERSION.split('.')
   end
 end

data/spec/chef/knife/ionoscloud_backupunit_get_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+require 'ionoscloud_backupunit_get'
+
+Chef::Knife::IonoscloudBackupunitGet.load_deps
+
+describe Chef::Knife::IonoscloudBackupunitGet do
+  before :each do
+    subject { Chef::Knife::IonoscloudBackupunitGet.new }
+
+    allow(subject).to receive(:puts)
+    allow(subject).to receive(:print)
+  end
+
+  describe '#run' do
+    it 'should call BackupUnitsApi.backupunits_find_by_id' do
+      backupunit = backupunit_mock
+      subject_config = {
+        ionoscloud_username: 'email',
+        ionoscloud_password: 'password',
+        backupunit_id: backupunit.id,
+        yes: true,
+      }
+
+      subject_config.each { |key, value| subject.config[key] = value }
+
+      expect(subject).to receive(:puts).with("ID: #{backupunit.id}")
+      expect(subject).to receive(:puts).with("Name: #{backupunit.properties.name}")
+      expect(subject).to receive(:puts).with("Email: #{backupunit.properties.email}")
+
+      expect(subject.api_client).not_to receive(:wait_for)
+      mock_call_api(
+        subject,
+        [
+          {
+            method: 'GET',
+            path: "/backupunits/#{backupunit.id}",
+            operation: :'BackupUnitsApi.backupunits_find_by_id',
+            return_type: 'BackupUnit',
+            result: backupunit,
+          },
+        ],
+      )
+
+      expect { subject.run }.not_to raise_error(Exception)
+    end
+
+    it 'should not make any call if any required option is missing' do
+      required_options = subject.instance_variable_get(:@required_options)
+
+      arrays_without_one_element(required_options).each do |test_case|
+
+        test_case[:array].each { |value| subject.config[value] = 'test' }
+
+        expect(subject).to receive(:puts).with("Missing required parameters #{test_case[:removed]}")
+        expect(subject.api_client).not_to receive(:call_api)
+
+        expect { subject.run }.to raise_error(SystemExit) do |error|
+          expect(error.status).to eq(1)
+        end
+
+        required_options.each { |value| subject.config[value] = nil }
+      end
+    end
+  end
+end