ovh-provisioner 0.1.0

data/lib/ovh/provisioner/api_object/domain_zone.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2015-2016 Sam4Mobile, 2017-2018 Make.org
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module OVH
+  module Provisioner
+    module APIObject
+      # Represent a Domain
+      class DomainZone < APIObject
+        attr_reader :nameservers, :dnssec_supported, :dnssec, :records
+
+        def to_s
+          "#{id}, dnssec #{dnssec_to_s}, #{records.list.size} records"
+        end
+
+        def details(record_lists = records)
+          "#{id} - dnssec: #{dnssec_to_s}\n"\
+            "#{(record_lists.format('type').lines[1..-1] || []).join('')}"
+        end
+
+        def add_record(subdomain, type, target, ttl = 0)
+          body = {
+            'fieldType' => type.upcase,
+            'target' => target,
+            'ttl' => ttl.to_i
+          }
+          sub = subdomain
+          body['subDomain'] = sub unless sub.nil? || sub.empty?
+          answer = post('record', body)
+          post('refresh')
+          format(answer)
+        end
+
+        def rm_record(record)
+          out = delete("record/#{record.id}")
+          post('refresh')
+          "  #{record}#{out.nil? ? '' : ": #{out}"}"
+        end
+
+        def rm_records(records)
+          outputs = records.parallel_map(:rm_record, [], Actor.current)
+          (["#{id}, remove records:"] + outputs.sort).join("\n")
+        end
+
+        def filter_records(config)
+          filter = generate_filter(
+            config['subdomain'] || '',
+            config['type'] || '',
+            config['target'] || '',
+            config['ttl'] || ''
+          )
+          targets = records.list.dup.keep_if do |record|
+            filter.call(record)
+          end.map(&:id)
+          Actor[Spawner::NAME].get('Record', *targets, parent: @url)
+        end
+
+        private
+
+        def set_general
+          general = get
+          @nameservers = general['nameServers']
+          @dnssec_supported = general['dnssecSupported']
+        end
+
+        def set_dnssec
+          @dnssec = get('dnssec')['status']
+        end
+
+        def set_records
+          @records = Actor[Spawner::NAME].get('Record', '', parent: @url)
+        end
+
+        def dnssec_to_s
+          dnssec_supported ? dnssec : 'not supported'
+        end
+
+        def generate_filter(subdomain, type, target, ttl)
+          lambda do |record|
+            record.subdomain.include?(subdomain) &&
+              (type.empty? || record.type == type.upcase) &&
+              record.target.include?(target) &&
+              (ttl == '' || record.ttl == ttl.to_i)
+          end
+        end
+
+        def format(answer)
+          return answer if answer.is_a? String
+
+          zone = answer['zone']
+          sub = answer['subDomain'] || ''
+          ttl = answer['ttl']
+          type = answer['fieldType']
+          target = answer['target']
+          "#{id}, add record:\n"\
+            "  #{Record.print(zone, sub, ttl, type, target)}"
+        end
+      end
+    end
+  end
+end

data/lib/ovh/provisioner/api_object/ip.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2015-2016 Sam4Mobile, 2017-2018 Make.org
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module OVH
+  module Provisioner
+    module APIObject
+      # Represent an OVH IP
+      class IP < APIObject
+        attr_reader :organisation_id, :country
+        attr_reader :routed_to, :can_be_terminated, :type
+        attr_reader :description
+        attr_reader :reverse
+        attr_reader :kind
+
+        def add_reverse(reverse)
+          body = {
+            'ipReverse' => id.split('/').first,
+            'reverse' => reverse
+          }
+          response = post('reverse', body)
+          unless response['reverse'].nil?
+            response = "#{id} - reverse #{reverse} has been added"
+            @reverse = reverse['reverse']
+          end
+          response
+        end
+
+        def rm_reverse
+          response = delete("reverse/#{id.split('/').first}")
+          response ||= "#{id} - reverse #{reverse} has been removed"
+          response
+        end
+
+        def to_s
+          base = "#{id} - #{routed_to}(#{type}) - #{endable}"
+          %i[organisation_id country reverse description].each do |key|
+            value = send(key)
+            base += "\n  #{key}: #{value}" unless value.nil?
+          end
+          base
+        end
+
+        private
+
+        def set_general
+          general = get
+          @organisation_id = general['organisationId']
+          @country = general['country']
+          routed = general['routedTo']
+          @routed_to = routed.nil? ? nil : routed['serviceName']
+          @can_be_terminated = general['canBeTerminated']
+          @type = general['type']
+          @description = general['description']
+          @kind = id.include?(':') ? 'ipv6' : 'ipv4'
+        end
+
+        def set_reverse
+          reverse = get("reverse/#{id.split('/').first}")
+          @reverse = reverse['reverse']
+        end
+
+        def endable
+          can_be_terminated ? 'endable' : 'non endable'
+        end
+      end
+    end
+  end
+end

data/lib/ovh/provisioner/api_object/record.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2015-2016 Sam4Mobile, 2017-2018 Make.org
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module OVH
+  module Provisioner
+    module APIObject
+      # Represent a record in a domain zone
+      class Record < APIObject
+        attr_reader :target, :ttl, :zone, :type, :subdomain
+
+        def self.print(zone, subdomain, ttl, type, target)
+          "#{subdomain.empty? ? "#{zone}." : subdomain} "\
+            "#{ttl} #{type} #{target}".strip
+        end
+
+        def to_s
+          self.class.print(zone, subdomain, ttl, type, target)
+        end
+
+        private
+
+        def set_general
+          general = get
+          @target = general['target']
+          @ttl = general['ttl']
+          @zone = general['zone']
+          @type = general['fieldType']
+          @subdomain = general['subDomain']
+        end
+      end
+    end
+  end
+end

data/lib/ovh/provisioner/api_object/vrack.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2015-2016 Sam4Mobile, 2017-2018 Make.org
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module OVH
+  module Provisioner
+    module APIObject
+      # Represent a VRack
+      class Vrack < APIObject
+        attr_reader :name, :description, :dedicated_servers, :tasks
+
+        def add(api_object)
+          path = path_from(api_object)
+          ok, msg = parse_task(post(path, path => api_object.id))
+          "#{api_object.id}: #{ok ? 'ok' : 'failed'}\n  #{msg}"
+        end
+
+        def remove(api_object)
+          path = "#{path_from(api_object)}/#{api_object.id}"
+          ok, msg = parse_task(delete(path))
+          "#{api_object.id}: #{ok ? 'ok' : 'failed'}\n  #{msg}"
+        end
+
+        def to_s
+          "#{name}: #{id}#{" - #{description}" unless description.empty?}" \
+          "#{list_to_s(:dedicated_servers)}" \
+          "#{list_to_s(:tasks)}"
+        end
+
+        private
+
+        def set_general
+          general = get
+          @name = general['name']
+          @description = general['description']
+        end
+
+        def set_dedicated_server
+          @dedicated_servers = get('dedicatedServer')
+        end
+
+        def set_tasks
+          tasks = get('task')
+          futures = tasks.map { |t| future.get("task/#{t}") }
+          @tasks = futures.map do |future|
+            _ok, msg = parse_task(future.value)
+            msg
+          end
+        end
+
+        def list_to_s(list_sym)
+          list = send(list_sym)
+          return '' if list.nil? || list.empty?
+
+          header = ["\n  #{list_sym}:"]
+          tail = list.map { |i| "    #{i}" }.sort
+          (header + tail).join("\n")
+        end
+
+        def path_from(api_object)
+          name = api_object.class.classname
+          "#{name[0..0].downcase}#{name[1..-1]}"
+        end
+
+        def parse_task(msg)
+          return [false, msg] if msg.is_a?(String)
+
+          method = /^[[:lower:]]+/.match(msg['function']).to_a.first
+          [
+            true,
+            "#{msg['status']} #{msg['serviceName']}.#{method}" \
+            "(#{msg['targetDomain']})"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/ovh/provisioner/cli.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2015-2016 Sam4Mobile, 2017-2018 Make.org
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'thor'
+require 'pp'
+require 'ruby-progressbar'
+require 'highline/import'
+Dir[File.dirname(__FILE__) + '/cli*.rb'].each { |file| require file }
+
+# Monkey patch Thor to fix #261
+module ThorPatching
+  def banner(command, namespace = nil, subcommand = false)
+    array = super.split(' ')
+    array[1] = array[1].tr('_', '')[3..-1] if array[1].start_with?('cli_')
+    array.join(' ')
+  end
+end
+
+# Prepending the patch
+class Thor
+  class << self
+    prepend ThorPatching
+  end
+end
+
+module OVH
+  module Provisioner
+    # The command line runner
+    class Cli < Thor # rubocop:disable Metrics/ClassLength
+      desc 'version', 'print OVH Provisioner\'s version information'
+      def version
+        say "OVH Provisioner version #{OVH::Provisioner::VERSION}"
+      end
+      map %w[-v --version] => :version
+
+      desc 'list targets', 'print the list of your dedicated servers'
+      def list(*targets)
+        spawner = Provisioner.init(options)
+        puts spawner
+          .get('DedicatedServer', *self.class.all(targets))
+          .format('vrack', 'flavor')
+      end
+
+      option(
+        :force,
+        type: :boolean,
+        desc: 'Force the installation even if the server is already installed',
+        default: false,
+        aliases: ['-f']
+      )
+      option(
+        :template,
+        desc: 'Template to install',
+        aliases: ['-t']
+      )
+      option(
+        :ssh_key_name,
+        desc: 'Name of the ssh key to install',
+        aliases: ['-n']
+      )
+      option(
+        :use_distrib_kernel,
+        type: :boolean,
+        desc: 'Use official kernel instead of OVH\'s (default = false)',
+        aliases: ['-d']
+      )
+      option(
+        :custom_hostname,
+        desc: 'Hostname of the server (default = reverse)',
+        aliases: ['-h']
+      )
+      desc 'install targets', 'install/reinstall one or more dedicated servers'
+      def install(*targets)
+        spawner = Provisioner.init(options)
+        servers = spawner.get('DedicatedServer', *self.class.all(targets))
+        self.class.ask_validation(
+          'You are going to (re)install those servers:',
+          servers.format('install_status', 'flavor')
+        )
+        servers.puts_each(:install)
+      end
+
+      NAME_SCHEME = [
+        :name_scheme,
+        desc: 'Name scheme to use for the servers, ex: %<flavor_tag>s-%<id>s',
+        aliases: ['-n']
+      ].freeze
+      NAME_DOMAIN = [
+        :name_domain,
+        desc: 'Domain of the servers, ex: test.com',
+        aliases: ['-d']
+      ].freeze
+
+      option(*NAME_SCHEME)
+      option(*NAME_DOMAIN)
+      desc 'rename targets', 'rename one or more dedicated servers'
+      def rename(*targets)
+        servers, domain = init_rename(targets)
+        # Add check on duplication?
+        self.class.ask_validation(
+          'You are going to rename those servers:',
+          servers.list.map do |s|
+            "  #{s.reverse} => #{s.newname}.#{domain.id}"
+          end.join("\n")
+        )
+        servers.puts_each(:rename, [domain])
+        puts 'To complete renaming, call "set_reverse" in a few minute'
+      end
+
+      option(*NAME_SCHEME)
+      option(*NAME_DOMAIN)
+      desc 'set_reverse targets', 'set the reverse for a server'
+      def set_reverse(*targets) # rubocop:disable Style/AccessorMethodName
+        servers, domain = init_rename(targets)
+        servers.puts_each(:define_reverse, [domain])
+      end
+
+      # TODO: test it!
+      desc 'ipmi target', 'create ipmi interface and launch javaws on it'
+      def ipmi(*targets)
+        spawner = Provisioner.init(options)
+        servers = spawner.get('DedicatedServer', *self.class.all(targets))
+        list = servers.list
+        unless list.size == 1
+          puts 'Please select one and only one target! You have targeted:'
+          puts servers.format('flavor')
+          exit 1
+        end
+        list.first.ipmi
+      end
+
+      desc 'get url', 'execute a get on url'
+      def get(url)
+        Provisioner.init(options)
+        puts Provisioner.client.get url
+      end
+
+      desc 'vrack SUBCOMMAND ...ARGS', 'Manage Vracks'
+      subcommand 'vrack', CliVrack
+
+      desc 'domain SUBCOMMAND ...ARGS', 'Manage Domains'
+      subcommand 'domain', CliDomain
+
+      desc 'ip SUBCOMMAND ...ARGS', 'Manage IPs'
+      subcommand 'ip', CliIP
+
+      no_commands do
+        def init_rename(targets)
+          spawner = Provisioner.init(options)
+          servers = spawner.get('DedicatedServer', *self.class.all(targets))
+          name_domain = Provisioner.config['name_domain']
+          domain = spawner.get('DomainZone', id: name_domain)
+          [servers, domain]
+        end
+      end
+    end
+  end
+end