3scale_toolbox 0.15.0 → 0.18.2

data/lib/3scale_toolbox/commands/backend_command/copy_command/create_or_update_target_backend_task.rb

@@ -0,0 +1,46 @@
+module ThreeScaleToolbox
+  module Commands
+    module BackendCommand
+      module CopyCommand
+        class CreateOrUpdateTargetBackendTask
+          include Task
+
+          # entrypoint
+          def run
+            backend = Entities::Backend.find(remote: target_remote, ref: target_backend_ref)
+
+            if backend.nil?
+              backend = Entities::Backend.create(remote: target_remote,
+                                                 attrs: create_attrs)
+            elsif backend == source_backend
+              message = 'source and destination backends are the same: ' \
+                "ID: #{source_backend.id} system_name: #{source_backend.attrs['system_name']}"
+              warn "\e[1m\e[31mWarning: #{message}\e[0m"
+            else
+              backend.update update_attrs
+            end
+
+            # assign target backend for other tasks to have it available
+            self.target_backend = backend
+
+            logger.info "source backend ID: #{source_backend.id} system_name: #{source_backend.system_name}"
+            logger.info "target backend ID: #{target_backend.id} system_name: #{target_backend.system_name}"
+            report['backend_id'] = target_backend.id
+          end
+
+          def create_attrs
+            source_backend.attrs.merge('system_name' => target_backend_ref)
+          end
+
+          def update_attrs
+            source_backend.attrs.merge('system_name' => target_backend_ref)
+          end
+
+          def target_backend_ref
+            option_target_system_name || source_backend.attrs.fetch('system_name')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/backend_command/copy_command/task.rb

@@ -0,0 +1,67 @@
+module ThreeScaleToolbox
+  module Commands
+    module BackendCommand
+      module CopyCommand
+        module Task
+          attr_reader :context
+
+          def initialize(context)
+            @context = context
+          end
+
+          def call
+            run
+          end
+
+          def target_backend=(target)
+            context[:target_backend] = target
+          end
+
+          def target_backend
+            context[:target_backend] ||= raise ThreeScaleToolbox::Error, 'Unexpected error. ' \
+              'Target backend should have been created or updated'
+          end
+
+          def source_backend
+            context[:source_backend] ||= find_source_backend
+          end
+
+          def source_remote
+            context[:source_remote]
+          end
+
+          def target_remote
+            context[:target_remote]
+          end
+
+          def source_backend_ref
+            context[:source_backend_ref] ||= raise ThreeScaleToolbox::Error, 'Unexpected error. ' \
+              'source_backend_ref not found'
+          end
+
+          def option_target_system_name
+            context[:option_target_system_name]
+          end
+
+          def logger
+            context[:logger] ||= Logger.new($stdout).tap do |logger|
+              logger.formatter = proc { |severity, datetime, progname, msg| "#{msg}\n" }
+            end
+          end
+
+          def report
+            context[:report] ||= {}
+          end
+
+          private
+
+          def find_source_backend
+            Entities::Backend.find(remote: source_remote, ref: source_backend_ref).tap do |backend|
+              raise ThreeScaleToolbox::Error, "Backend #{source_backend_ref} does not exist" if backend.nil?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/copy_command.rb

@@ -1,4 +1,4 @@
-require '3scale_toolbox/commands/copy_command/copy_service'
+require '3scale_toolbox/commands/copy_command/service_command'
 
 module ThreeScaleToolbox
   module Commands
@@ -16,7 +16,7 @@ module ThreeScaleToolbox
           end
         end
       end
-      add_subcommand(CopyServiceSubcommand)
+      add_subcommand(ServiceSubcommand)
     end
   end
 end

data/lib/3scale_toolbox/commands/copy_command/service_command.rb

@@ -0,0 +1,40 @@
+module ThreeScaleToolbox
+  module Commands
+    module CopyCommand
+      class ServiceSubcommand < Cri::CommandRunner
+        include ThreeScaleToolbox::Command
+
+        def self.command
+          Cri::Command.define do
+            name        'service'
+            usage       'service [opts] -s <src> -d <dst> <source-service>'
+            summary     'copy service'
+            description <<-HEREDOC
+            This command makes a copy of the referenced service.
+            Target service will be searched by source service system name. System name can be overriden with `--target_system_name` option.
+            If a service with the selected `system_name` is not found, it will be created.
+            \n Components of the service being copied:
+            \nservice settings
+            \nproxy settings
+            \npricing rules
+            \nactivedocs
+            \nmetrics
+            \nmethods
+            \napplication plans
+            \nmapping rules
+            HEREDOC
+
+            option  :s, :source, '3scale source instance. Url or remote name', argument: :required
+            option  :d, :destination, '3scale target instance. Url or remote name', argument: :required
+            option  :t, 'target_system_name', 'Target system name. Default to source system name', argument: :required
+            flag    :f, :force, 'Overwrites the mapping rules by deleting all rules from target service first'
+            flag    :r, 'rules-only', 'Only mapping rules are copied'
+            param   :source_service
+
+            runner Commands::ServiceCommand::CopySubcommand
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/import_command/issuer_type_transformer.rb

@@ -0,0 +1,16 @@
+module ThreeScaleToolbox
+  module Commands
+    module ImportCommand
+      module OpenAPI
+        # Helper class to validate values for the oidc-issuer-type argument of the import openapi command
+        class IssuerTypeTransformer
+          def call(issuer_type)
+            raise unless %w[rest keycloak].include?(issuer_type)
+
+            issuer_type
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/import_command/openapi.rb

@@ -9,6 +9,7 @@ require '3scale_toolbox/commands/import_command/openapi/create_activedocs_step'
 require '3scale_toolbox/commands/import_command/openapi/update_service_proxy_step'
 require '3scale_toolbox/commands/import_command/openapi/update_service_oidc_conf_step'
 require '3scale_toolbox/commands/import_command/openapi/update_policies_step'
+require '3scale_toolbox/commands/import_command/issuer_type_transformer'
 
 module ThreeScaleToolbox
   module Commands
@@ -30,6 +31,7 @@ module ThreeScaleToolbox
               flag    nil, 'activedocs-hidden', 'Create ActiveDocs in hidden state'
               flag    nil, 'skip-openapi-validation', 'Skip OpenAPI schema validation'
               flag    nil, 'prefix-matching', 'Use prefix matching instead of strict matching on mapping rules derived from openapi operations'
+              option  nil, 'oidc-issuer-type', 'OIDC Issuer Type (rest, keycloak)', argument: :required, transform: IssuerTypeTransformer.new            
               option  nil, 'oidc-issuer-endpoint', 'OIDC Issuer Endpoint', argument: :required
               option  nil, 'default-credentials-userkey', 'Default credentials policy userkey', argument: :required
               option  nil, 'override-private-basepath', 'Override the basepath for the private URLs', argument: :required
@@ -51,7 +53,7 @@ module ThreeScaleToolbox
             # other tasks might read proxy settings (CreateActiveDocsStep does)
             tasks << UpdateServiceProxyStep.new(context)
             tasks << CreateMethodsStep.new(context)
-            tasks << Tasks::DestroyMappingRulesTask.new(context)
+            tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::DestroyMappingRulesTask.new(context)
             tasks << CreateMappingRulesStep.new(context)
             tasks << CreateActiveDocsStep.new(context)
             tasks << UpdateServiceOidcConfStep.new(context)
@@ -61,7 +63,7 @@ module ThreeScaleToolbox
             tasks.each(&:call)
 
             # This should be the last step
-            Tasks::BumpProxyVersionTask.new(service: context[:target]).call
+            ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::BumpProxyVersionTask.new(service: context[:target]).call
           end
 
           private
@@ -77,6 +79,7 @@ module ThreeScaleToolbox
               threescale_client: threescale_client(fetch_required_option(:destination)),
               target_system_name: options[:target_system_name],
               activedocs_published: !options[:'activedocs-hidden'],
+              oidc_issuer_type: options[:'oidc-issuer-type'],
               oidc_issuer_endpoint: options[:'oidc-issuer-endpoint'],
               default_credentials_userkey: options[:'default-credentials-userkey'],
               skip_openapi_validation: options[:'skip-openapi-validation'],
@@ -88,6 +91,7 @@ module ThreeScaleToolbox
               backend_api_secret_token: options[:'backend-api-secret-token'],
               backend_api_host_header: options[:'backend-api-host-header'],
               prefix_matching: options[:'prefix-matching'],
+              delete_mapping_rules: true,
             }
           end
 

data/lib/3scale_toolbox/commands/import_command/openapi/create_mapping_rule_step.rb

@@ -7,7 +7,8 @@ module ThreeScaleToolbox
 
           def call
             operations.each do |op|
-              service.create_mapping_rule(op.mapping_rule)
+              Entities::MappingRule.create(service: service,
+                                           attrs: op.mapping_rule)
               puts "Created #{op.http_method} #{op.pattern} endpoint"
             end
           end

data/lib/3scale_toolbox/commands/import_command/openapi/create_method_step.rb

@@ -7,18 +7,13 @@ module ThreeScaleToolbox
 
           def call
             missing_operations.each do |op|
-              method = Entities::Method.create(service: service, parent_id: hits_metric_id,
-                                               attrs: op.method)
+              method = Entities::Method.create(service: service, attrs: op.method)
               op.set(:metric_id, method.id)
             end
 
             existing_operations.each do |op|
-              method_attrs = methods_index.fetch(op.method['system_name'])
-              method = Entities::Method.new(
-                id: method_attrs.fetch('id'),
-                parent_id: hits_metric_id,
-                service: service
-              )
+              method_attrs = methods_index.fetch(op.method['system_name']).attrs
+              method = Entities::Method.new(id: method_attrs.fetch('id'), service: service)
               method.update(op.method)
               op.set(:metric_id, method.id)
             end
@@ -26,13 +21,9 @@ module ThreeScaleToolbox
 
           private
 
-          def hits_metric_id
-            @hits_metric_id ||= service.hits['id']
-          end
-
           def methods_index
-            @methods_index ||= service.methods(hits_metric_id).each_with_object({}) do |method, acc|
-              acc[method['system_name']] = method
+            @methods_index ||= service.methods.each_with_object({}) do |method, acc|
+              acc[method.system_name] = method
             end
           end
 

data/lib/3scale_toolbox/commands/import_command/openapi/step.rb

@@ -57,6 +57,10 @@ module ThreeScaleToolbox
             context[:api_spec_resource]
           end
 
+          def oidc_issuer_type
+            context[:oidc_issuer_type]
+          end
+
           def oidc_issuer_endpoint
             context[:oidc_issuer_endpoint]
           end

data/lib/3scale_toolbox/commands/import_command/openapi/update_service_proxy_step.rb

@@ -52,6 +52,7 @@ module ThreeScaleToolbox
             case (type = api_spec.security[:type])
             when 'oauth2'
               settings[:credentials_location] = 'headers'
+              settings[:oidc_issuer_type] = oidc_issuer_type unless oidc_issuer_type.nil?
               settings[:oidc_issuer_endpoint] = oidc_issuer_endpoint unless oidc_issuer_endpoint.nil?
             when 'apiKey'
               settings[:credentials_location] = credentials_location

data/lib/3scale_toolbox/commands/methods_command/apply_command.rb

@@ -2,6 +2,24 @@ module ThreeScaleToolbox
   module Commands
     module MethodsCommand
       module Apply
+        class CustomPrinter
+          attr_reader :option_disabled, :option_enabled
+
+          def initialize(options)
+            @option_disabled = options[:disabled]
+            @option_enabled = options[:enabled]
+          end
+
+          def print_record(method)
+            output_msg_array = ["Applied method id: #{method['id']}"]
+            output_msg_array << 'Disabled' if option_disabled
+            output_msg_array << 'Enabled' if option_enabled
+            puts output_msg_array.join('; ')
+          end
+
+          def print_collection(collection) end
+        end
+
         class ApplySubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
@@ -16,6 +34,8 @@ module ThreeScaleToolbox
               flag        nil, :disabled, 'Disables this method in all application plans'
               flag        nil, :enabled, 'Enables this method in all application plans'
               option      nil, :description, 'Method description', argument: :required
+              ThreeScaleToolbox::CLI.output_flag(self)
+
               param       :remote
               param       :service_ref
               param       :method_ref
@@ -27,11 +47,9 @@ module ThreeScaleToolbox
           def run
             validate_option_params
             hits = service.hits
-            method = Entities::Method.find(service: service, parent_id: hits.fetch('id'),
-                                           ref: method_ref)
+            method = Entities::Method.find(service: service, ref: method_ref)
             if method.nil?
-              method = Entities::Method.create(service: service, parent_id: hits.fetch('id'),
-                                               attrs: create_method_attrs)
+              method = Entities::Method.create(service: service, attrs: create_method_attrs)
             else
               method.update(method_attrs) unless method_attrs.empty?
             end
@@ -39,10 +57,7 @@ module ThreeScaleToolbox
             method.disable if option_disabled
             method.enable if option_enabled
 
-            output_msg_array = ["Applied method id: #{method.id}"]
-            output_msg_array << 'Disabled' if option_disabled
-            output_msg_array << 'Enabled' if option_enabled
-            puts output_msg_array.join('; ')
+            printer.print_record method.attrs
           end
 
           private
@@ -94,6 +109,11 @@ module ThreeScaleToolbox
           def method_ref
             arguments[:method_ref]
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new(disabled: option_disabled, enabled: option_enabled))
+          end
         end
       end
     end

data/lib/3scale_toolbox/commands/methods_command/create_command.rb

@@ -2,6 +2,20 @@ module ThreeScaleToolbox
   module Commands
     module MethodsCommand
       module Create
+        class CustomPrinter
+          attr_reader :option_disabled
+
+          def initialize(options)
+            @option_disabled = options[:disabled]
+          end
+
+          def print_record(method)
+            puts "Created method id: #{method['id']}. Disabled: #{option_disabled}"
+          end
+
+          def print_collection(collection) end
+        end
+
         class CreateSubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
@@ -15,6 +29,8 @@ module ThreeScaleToolbox
               option      :t, 'system-name', 'Method system name', argument: :required
               flag        nil, :disabled, 'Disables this method in all application plans'
               option      nil, :description, 'Method description', argument: :required
+              ThreeScaleToolbox::CLI.output_flag(self)
+
               param       :remote
               param       :service_ref
               param       :method_name
@@ -24,14 +40,13 @@ module ThreeScaleToolbox
           end
 
           def run
-            hits = service.hits
             method = ThreeScaleToolbox::Entities::Method.create(
               service: service,
-              parent_id: hits.fetch('id'),
               attrs: method_attrs
             )
             method.disable if option_disabled
-            puts "Created method id: #{method.id}. Disabled: #{option_disabled}"
+
+            printer.print_record method.attrs
           end
 
           private
@@ -66,6 +81,11 @@ module ThreeScaleToolbox
           def service_ref
             arguments[:service_ref]
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new(disabled: option_disabled))
+          end
         end
       end
     end

data/lib/3scale_toolbox/commands/methods_command/delete_command.rb

@@ -44,7 +44,7 @@ module ThreeScaleToolbox
 
           def find_method
             hits = service.hits
-            Entities::Method.find(service: service, parent_id: hits.fetch('id'), ref: method_ref).tap do |p|
+            Entities::Method.find(service: service, ref: method_ref).tap do |p|
               raise ThreeScaleToolbox::Error, "Method #{method_ref} does not exist" if p.nil?
             end
           end