3scale_toolbox 0.15.0 → 0.18.2

data/lib/3scale_toolbox/commands/activedocs_command/list_command.rb

@@ -11,16 +11,17 @@ module ThreeScaleToolbox
               usage       'list <remote>'
               summary     'List ActiveDocs'
               description 'List all defined ActiveDocs'
-              runner ListSubcommand
 
+              ThreeScaleToolbox::CLI.output_flag(self)
               param :remote
               option :s, :'service-ref', "Filter the ActiveDocs by Service reference", argument: :required
+
+              runner ListSubcommand
             end
           end
 
           def run
-            activedocs = remote.list_activedocs
-            print_activedocs_data(activedocs, ACTIVEDOCS_FIELDS_TO_SHOW)
+            printer.print_collection filtered_activedocs
           end
 
           private
@@ -34,13 +35,9 @@ module ThreeScaleToolbox
             @remote ||= threescale_client(arguments[:remote])
           end
 
-          def print_activedocs_data(activedocs, fields_to_show)
-            print_header(fields_to_show)
-            print_results(activedocs, fields_to_show)
-          end
-
-          def print_header(fields_to_show)
-            puts fields_to_show.map { |e| e.upcase }.join("\t")
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CLI::CustomTablePrinter.new(ACTIVEDOCS_FIELDS_TO_SHOW))
           end
 
           def service_ref_filter
@@ -55,13 +52,9 @@ module ThreeScaleToolbox
             res
           end
 
-          def filtered_activedocs(activedocs)
-            filters.reduce(activedocs) { |current_list, filter| filter.filter(current_list) }
-          end
-
-          def print_results(activedocs, fields_to_show)
-            filtered_activedocs(activedocs).each do |activedoc|
-              puts fields_to_show.map { |field| activedoc.fetch(field, '(empty)') }.join("\t")
+          def filtered_activedocs
+            filters.reduce(remote.list_activedocs) do |current_list, filter|
+              filter.filter(current_list)
             end
           end
         end

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

@@ -2,6 +2,24 @@ module ThreeScaleToolbox
   module Commands
     module ApplicationCommand
       module Apply
+        class CustomPrinter
+          attr_reader :option_resume, :option_suspend
+
+          def initialize(options)
+            @option_resume = options[:resume]
+            @option_suspend = options[:suspend]
+          end
+
+          def print_record(application)
+            output_msg_array = ["Applied application id: #{application['id']}"]
+            output_msg_array << 'Resumed' if option_resume
+            output_msg_array << 'Suspended' if option_suspend
+            puts output_msg_array.join('; ')
+          end
+
+          def print_collection(collection) end
+        end
+
         class ApplySubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
@@ -28,6 +46,8 @@ module ThreeScaleToolbox
               option      nil, :'redirect-url', 'OpenID Connect redirect url', argument: :required
               flag        nil, :resume, 'Resume a suspended application'
               flag        nil, :suspend, 'Suspends an application (changes the state to suspended)'
+              ThreeScaleToolbox::CLI.output_flag(self)
+
               param       :remote
               param       :application
 
@@ -52,10 +72,8 @@ module ThreeScaleToolbox
 
             application.resume if option_resume
             application.suspend if option_suspend
-            output_msg_array = ["Applied application id: #{application.id}"]
-            output_msg_array << 'Resumed' if option_resume
-            output_msg_array << 'Suspended' if option_suspend
-            puts output_msg_array.join('; ')
+
+            printer.print_record application.attrs
           end
 
           private
@@ -186,6 +204,11 @@ module ThreeScaleToolbox
           def option_redirect_url
             options[:'redirect-url']
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new(resume: option_resume, suspend: option_suspend))
+          end
         end
       end
     end

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

@@ -2,6 +2,14 @@ module ThreeScaleToolbox
   module Commands
     module ApplicationCommand
       module Create
+        class CustomPrinter
+          def print_record(application)
+            puts "Created application id: #{application['id']}"
+          end
+
+          def print_collection(collection) end
+        end
+
         class CreateSubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
@@ -17,6 +25,8 @@ module ThreeScaleToolbox
               option      nil, 'application-key', 'App Key(s) or Client Secret (for OAuth and OpenID Connect authentication modes) of the application to be created.' , argument: :required
               option      nil, :description, 'Application description', argument: :required
               option      nil, :'redirect-url', 'OpenID Connect redirect url', argument: :required
+              ThreeScaleToolbox::CLI.output_flag(self)
+
               param       :remote
               param       :account
               param       :service
@@ -35,7 +45,7 @@ module ThreeScaleToolbox
               app_attrs: app_attrs
             )
 
-            puts "Created application id: #{application.id}"
+            printer.print_record application.attrs
           end
 
           private
@@ -105,6 +115,11 @@ module ThreeScaleToolbox
           def remote
             @remote ||= threescale_client(arguments[:remote])
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new)
+          end
         end
       end
     end

data/lib/3scale_toolbox/commands/application_command/list_command.rb

@@ -14,10 +14,12 @@ module ThreeScaleToolbox
               summary     'list applications'
               description 'List applications'
 
-              param       :remote
               option      nil, :account, 'Filter by account', argument: :required
               option      nil, :service, 'Filter by service', argument: :required
               option      nil, :plan, 'Filter by application plan. Service option required', argument: :required
+              ThreeScaleToolbox::CLI.output_flag(self)
+
+              param       :remote
 
               runner ListSubcommand
             end
@@ -35,8 +37,8 @@ module ThreeScaleToolbox
                            else
                              provider_account_applications
                            end
-            print_header
-            print_data(applications)
+
+            printer.print_collection applications.map(&:attrs)
           end
 
           private
@@ -72,16 +74,6 @@ module ThreeScaleToolbox
             options[:plan]
           end
 
-          def print_header
-            puts FIELDS_TO_SHOW.map(&:upcase).join("\t")
-          end
-
-          def print_data(applications)
-            applications.each do |app|
-              puts FIELDS_TO_SHOW.map { |field| app.attrs.fetch(field, '(empty)') }.join("\t")
-            end
-          end
-
           def service
             @service ||= find_service
           end
@@ -117,6 +109,11 @@ module ThreeScaleToolbox
           def remote
             @remote ||= threescale_client(arguments[:remote])
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CLI::CustomTablePrinter.new(FIELDS_TO_SHOW))
+          end
         end
       end
     end

data/lib/3scale_toolbox/commands/application_command/show_command.rb

@@ -21,6 +21,8 @@ module ThreeScaleToolbox
               \n * Application internal id
               HEREDOC
 
+              ThreeScaleToolbox::CLI.output_flag(self)
+
               param       :remote
               param       :application
 
@@ -29,24 +31,11 @@ module ThreeScaleToolbox
           end
 
           def run
-            print_header
-            print_data
+            printer.print_record application.attrs
           end
 
           private
 
-          def print_header
-            puts FIELDS_TO_SHOW.map(&:upcase).join("\t")
-          end
-
-          def print_data
-            puts FIELDS_TO_SHOW.map { |field| app_attrs.fetch(field, '(empty)') }.join("\t")
-          end
-
-          def app_attrs
-            @app_attrs ||= application.attrs
-          end
-
           def application
             @application ||= find_application
           end
@@ -64,6 +53,11 @@ module ThreeScaleToolbox
           def remote
             @remote ||= threescale_client(arguments[:remote])
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CLI::CustomTablePrinter.new(FIELDS_TO_SHOW))
+          end
         end
       end
     end

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

@@ -0,0 +1,22 @@
+require '3scale_toolbox/commands/backend_command/copy_command'
+
+module ThreeScaleToolbox
+  module Commands
+    module BackendCommand
+      include ThreeScaleToolbox::Command
+      def self.command
+        Cri::Command.define do
+          name        'backend'
+          usage       'backend <sub-command> [options]'
+          summary     'backend super command'
+          description 'Backend commands'
+
+          run do |_opts, _args, cmd|
+            puts cmd.help
+          end
+        end
+      end
+      add_subcommand(CopySubcommand)
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+require '3scale_toolbox/commands/backend_command/copy_command/task'
+require '3scale_toolbox/commands/backend_command/copy_command/create_or_update_target_backend_task'
+require '3scale_toolbox/commands/backend_command/copy_command/copy_metrics_task'
+require '3scale_toolbox/commands/backend_command/copy_command/copy_methods_task'
+require '3scale_toolbox/commands/backend_command/copy_command/copy_mapping_rules_task'
+
+module ThreeScaleToolbox
+  module Commands
+    module BackendCommand
+      class CopySubcommand < Cri::CommandRunner
+        include ThreeScaleToolbox::Command
+
+        def self.command
+          Cri::Command.define do
+            name        'copy'
+            usage       'copy [opts] -s <source-remote> -d <target-remote> <source-backend>'
+            summary     'Copy backend'
+            description <<-HEREDOC
+            This command makes a copy of the referenced backend.
+            Target backend will be searched by source backend system name. System name can be overriden with `--target-system-name` option.
+            If a backend with the selected `system-name` is not found, it will be created.
+            \n Components of the backend being copied:
+            \nmetrics
+            \nmethods
+            \nmapping rules
+            \n\n If a backend with the selected `system-name` is found, it will be updated. Only missing metrics, methods and mapping rules will be created.
+            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
+            param   :source_backend
+
+            runner CopySubcommand
+          end
+        end
+
+        def run
+          tasks = []
+          tasks << CopyCommand::CreateOrUpdateTargetBackendTask.new(context)
+          # First metrics as methods need 'hits' metric in target backend
+          tasks << CopyCommand::CopyMetricsTask.new(context)
+          tasks << CopyCommand::CopyMethodsTask.new(context)
+          tasks << CopyCommand::CopyMappingRulesTask.new(context)
+          tasks.each(&:call)
+        end
+
+        private
+
+        def context
+          @context ||= create_context
+        end
+
+        def create_context
+          {
+            source_remote: threescale_client(fetch_required_option(:source)),
+            target_remote: threescale_client(fetch_required_option(:destination)),
+            source_backend_ref: arguments[:source_backend],
+            option_target_system_name: options[:'target-system-name']
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module ThreeScaleToolbox
+  module Commands
+    module BackendCommand
+      module CopyCommand
+        class CopyMappingRulesTask
+          include Task
+
+          # entrypoint
+          def run
+            missing_rules.each do |mapping_rule|
+              mr_attrs = mapping_rule.attrs.merge('metric_id' => metrics_map.fetch(mapping_rule.metric_id))
+              Entities::BackendMappingRule.create(backend: target_backend, attrs: mr_attrs)
+            end
+            logger.info "created #{missing_rules.size} mapping rules"
+            report['missing_mapping_rules_created'] = missing_rules.size
+          end
+
+          private
+
+          def metrics_map
+            @metrics_map ||= source_backend.metrics_mapping(target_backend)
+          end
+
+          def missing_rules
+            @missing_rules ||= ThreeScaleToolbox::Helper.array_difference(source_backend.mapping_rules, target_backend.mapping_rules) do |source_rule, target_rule|
+              source_rule.pattern == target_rule.pattern &&
+                source_rule.http_method == target_rule.http_method &&
+                source_rule.delta == target_rule.delta &&
+                metrics_map.fetch(source_rule.metric_id) == target_rule.metric_id
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module ThreeScaleToolbox
+  module Commands
+    module BackendCommand
+      module CopyCommand
+        class CopyMethodsTask
+          include Task
+
+          # entrypoint
+          def run
+            missing_methods.each(&method(:create_method))
+            logger.info "created #{missing_methods.size} missing methods"
+            report['missing_methods_created'] = missing_methods.size
+          end
+
+          private
+
+          def create_method(method)
+            Entities::BackendMethod.create(backend: target_backend, attrs:  method.attrs)
+          rescue ThreeScaleToolbox::ThreeScaleApiError => e
+            raise e unless ThreeScaleToolbox::Helper.system_name_already_taken_error?(e.apierrors)
+
+            warn "[WARN] backend method #{method.system_name} not created. " \
+              'Backend metric with the same system_name exists.'
+          end
+
+          def missing_methods
+            @missing_methods ||= ThreeScaleToolbox::Helper.array_difference(source_backend.methods, target_backend.methods) do |source, target|
+              source.system_name == target.system_name
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module ThreeScaleToolbox
+  module Commands
+    module BackendCommand
+      module CopyCommand
+        class CopyMetricsTask
+          include Task
+
+          # entrypoint
+          def run
+            missing_metrics.each(&method(:create_metric))
+            logger.info "created #{missing_metrics.size} missing metrics"
+            report['missing_metrics_created'] = missing_metrics.size
+          end
+
+          private
+
+          def create_metric(metric)
+            Entities::BackendMetric.create(backend: target_backend, attrs: metric.attrs)
+          end
+
+          def missing_metrics
+            @missing_metrics ||= ThreeScaleToolbox::Helper.array_difference(source_backend.metrics, target_backend.metrics) do |s_m, t_m|
+              s_m.system_name == t_m.system_name
+            end
+          end
+        end
+      end
+    end
+  end
+end