3scale_toolbox 0.15.0 → 0.18.2

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

@@ -1,4 +1,4 @@
-require '3scale_toolbox/commands/update_command/update_service'
+require '3scale_toolbox/commands/update_command/service_command'
 
 module ThreeScaleToolbox
   module Commands
@@ -8,7 +8,7 @@ module ThreeScaleToolbox
         Cri::Command.define do
           name        'update'
           usage       'update <sub-command> [options]'
-          summary     '[DEPRECTATED] update super command'
+          summary     '[DEPRECATED] update super command'
           description 'Update 3scale entities between tenants'
 
           run do |_opts, _args, cmd|
@@ -16,7 +16,7 @@ module ThreeScaleToolbox
           end
         end
       end
-      add_subcommand(UpdateServiceSubcommand)
+      add_subcommand(ServiceSubcommand)
     end
   end
 end

data/lib/3scale_toolbox/commands/update_command/{update_service.rb → service_command.rb}

@@ -1,16 +1,19 @@
+require '3scale_toolbox/commands/update_command/service_command/delete_activedocs_task'
+require '3scale_toolbox/commands/update_command/service_command/copy_service_settings_task'
+
 module ThreeScaleToolbox
   module Commands
     module UpdateCommand
-      class UpdateServiceSubcommand < Cri::CommandRunner
+      class ServiceSubcommand < Cri::CommandRunner
         include ThreeScaleToolbox::Command
 
         def self.command
           Cri::Command.define do
             name        'service'
             usage       'service [opts] -s <src> -d <dst> <src_service_id> <dst_service_id>'
-            summary     '[DEPRECTATED] update service'
+            summary     '[DEPRECATED] update service'
             description <<-HEREDOC
-            This command has been deprecated. Use '3scale copy service' instead.
+            This command has been deprecated. Use '3scale service copy' instead.
             \n Update existing service, update proxy settings, metrics, methods, application plans and mapping rules.'
             HEREDOC
 
@@ -22,11 +25,12 @@ module ThreeScaleToolbox
             param   :src_service_id
             param   :dst_service_id
 
-            runner UpdateServiceSubcommand
+            runner ServiceSubcommand
           end
         end
 
         def run
+          warn "\e[1m\e[31mThis command has been deprecated. Use '3scale service copy' instead\e[0m"
           source_service = Entities::Service.new(
             id: arguments[:src_service_id],
             remote: threescale_client(fetch_required_option(:source))
@@ -35,28 +39,27 @@ module ThreeScaleToolbox
             id: arguments[:dst_service_id],
             remote: threescale_client(fetch_required_option(:destination))
           )
-          system_name = options[:target_system_name]
           context = create_context(source_service, update_service)
 
           tasks = []
           unless options[:'rules-only']
-            tasks << Tasks::CopyServiceSettingsTask.new(context)
-            tasks << Tasks::CopyMethodsTask.new(context)
-            tasks << Tasks::CopyMetricsTask.new(context)
-            tasks << Tasks::CopyApplicationPlansTask.new(context)
-            tasks << Tasks::CopyLimitsTask.new(context)
-            tasks << Tasks::CopyPoliciesTask.new(context)
-            tasks << Tasks::CopyPricingRulesTask.new(context)
-            tasks << Tasks::DeleteActiveDocsTask.new(context)
-            tasks << Tasks::CopyActiveDocsTask.new(context)
+            tasks << ServiceCommand::CopyServiceSettingsTask.new(context)
+            tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyMethodsTask.new(context)
+            tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyMetricsTask.new(context)
+            tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyApplicationPlansTask.new(context)
+            tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyLimitsTask.new(context)
+            tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyPoliciesTask.new(context)
+            tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyPricingRulesTask.new(context)
+            tasks << ServiceCommand::DeleteActiveDocsTask.new(context)
+            tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyActiveDocsTask.new(context)
             # Copy proxy must be the last task
             # Proxy update is the mechanism to increase version of the proxy,
             # Hence propagating (mapping rules, poicies, oidc, auth) update to
             # latest proxy config, making available to gateway.
-            tasks << Tasks::CopyServiceProxyTask.new(context)
+            tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyServiceProxyTask.new(context)
           end
-          tasks << Tasks::DestroyMappingRulesTask.new(context) if options[:force]
-          tasks << Tasks::CopyMappingRulesTask.new(context)
+          tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::DestroyMappingRulesTask.new(context)
+          tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyMappingRulesTask.new(context)
 
           # run tasks
           tasks.each(&:call)
@@ -67,7 +70,8 @@ module ThreeScaleToolbox
         def create_context(source, target)
           {
             source: source,
-            target: target
+            target: target,
+            delete_mapping_rules: options[:force]
           }
         end
       end

data/lib/3scale_toolbox/commands/update_command/service_command/copy_service_settings_task.rb

@@ -0,0 +1,35 @@
+module ThreeScaleToolbox
+  module Commands
+    module UpdateCommand
+      module ServiceCommand
+        class CopyServiceSettingsTask
+          attr_reader :context
+
+          def initialize(context)
+            @context = context
+          end
+
+          def call
+            target.update source_attrs
+
+            puts "updated service settings for service id #{source.id}..."
+          end
+
+          private
+
+          def source
+            context[:source]
+          end
+
+          def target
+            context[:target]
+          end
+
+          def source_attrs
+            source.attrs.reject { |k, _| %w[system_name id links].include? k }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/update_command/service_command/delete_activedocs_task.rb

@@ -0,0 +1,24 @@
+module ThreeScaleToolbox
+  module Commands
+    module UpdateCommand
+      module ServiceCommand
+        class DeleteActiveDocsTask
+          attr_reader :context
+
+          def initialize(context)
+            @context = context
+          end
+
+          def call
+            puts 'deleting all target service ActiveDocs'
+            target.activedocs.each(&:delete)
+          end
+
+          def target
+            context[:target]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds.rb

@@ -0,0 +1,16 @@
+require '3scale_toolbox/crds/application_plan_dump'
+require '3scale_toolbox/crds/backend_method_dump'
+require '3scale_toolbox/crds/backend_mapping_rule_dump'
+require '3scale_toolbox/crds/backend_metric_dump'
+require '3scale_toolbox/crds/backend_dump'
+require '3scale_toolbox/crds/backend_usage_dump'
+require '3scale_toolbox/crds/limit_dump'
+require '3scale_toolbox/crds/mapping_rule_dump'
+require '3scale_toolbox/crds/method_dump'
+require '3scale_toolbox/crds/metric_dump'
+require '3scale_toolbox/crds/pricing_rule_dump'
+require '3scale_toolbox/crds/product_dump'
+require '3scale_toolbox/crds/product_deployment_parser'
+require '3scale_toolbox/crds/backend_parser'
+require '3scale_toolbox/crds/product_parser'
+require '3scale_toolbox/crds/remote'

data/lib/3scale_toolbox/crds/application_plan_dump.rb

@@ -0,0 +1,19 @@
+module ThreeScaleToolbox
+  module CRD
+    module ApplicationPlanSerializer
+      def to_cr
+        {
+          'name' => name,
+          'appsRequireApproval' => approval_required?,
+          'trialPeriod' => trial_period_days,
+          'setupFee' => setup_fee,
+          'custom' => custom,
+          'state' => state,
+          'costMonth' => cost_per_month,
+          'pricingRules' => pricing_rules.map(&:to_cr),
+          'limits' => limits.map(&:to_cr)
+        }
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/backend_dump.rb

@@ -0,0 +1,39 @@
+module ThreeScaleToolbox
+  module CRD
+    module BackendSerializer
+      def to_cr
+        {
+          'apiVersion' => 'capabilities.3scale.net/v1beta1',
+          'kind' => 'Backend',
+          'metadata' => {
+            'annotations' => {
+              '3scale_toolbox_created_at' => Time.now.utc.iso8601,
+              '3scale_toolbox_version' => ThreeScaleToolbox::VERSION
+            },
+            'name' => cr_name
+          },
+          'spec' => {
+            'name' => name,
+            'systemName' => system_name,
+            'privateBaseURL' => private_endpoint,
+            'description' => description,
+            'mappingRules' => mapping_rules.map(&:to_cr),
+            'metrics' => metrics.each_with_object({}) do |metric, hash|
+              hash[metric.system_name] = metric.to_cr
+            end,
+            'methods' => methods.each_with_object({}) do |method, hash|
+              hash[method.system_name] = method.to_cr
+            end
+          }
+        }
+      end
+
+      def cr_name
+        # Should be DNS1123 subdomain name
+        # TODO run validation for DNS1123
+        # https://kubernetes.io/docs/concepts/overview/working-with-objects/names/
+        "#{system_name.gsub(/[^[a-zA-Z0-9\-\.]]/, '.')}.#{Helper.random_lowercase_name}"
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/backend_mapping_rule_dump.rb

@@ -0,0 +1,26 @@
+module ThreeScaleToolbox
+  module CRD
+    module BackendMappingRuleSerializer
+      def to_cr
+        {
+          'httpMethod' => http_method,
+          'pattern' => pattern,
+          'metricMethodRef' => metric_method_ref,
+          'increment' => delta,
+          'last' => last,
+        }
+      end
+
+      def metric_method_ref
+        if (method = backend.methods.find { |m| m.id == metric_id })
+          method.system_name
+        elsif (metric = backend.metrics.find { |m| m.id == metric_id })
+          metric.system_name
+        else
+          raise ThreeScaleToolbox::Error, "Unexpected error. Backend #{backend.system_name} " \
+            "mapping rule #{id} referencing to metric id #{metric_id} which has not been found"
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/backend_method_dump.rb

@@ -0,0 +1,12 @@
+module ThreeScaleToolbox
+  module CRD
+    module BackendMethodSerializer
+      def to_cr
+        {
+          'friendlyName' => friendly_name,
+          'description' => description,
+        }
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/backend_metric_dump.rb

@@ -0,0 +1,13 @@
+module ThreeScaleToolbox
+  module CRD
+    module BackendMetricSerializer
+      def to_cr
+        {
+          'friendlyName' => friendly_name,
+          'unit' => unit,
+          'description' => description,
+        }
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/backend_parser.rb

@@ -0,0 +1,55 @@
+module ThreeScaleToolbox
+  module CRD
+    class BackendParser
+      Metric = Struct.new(:system_name, :friendly_name, :description, :unit)
+      Method = Struct.new(:system_name, :friendly_name, :description)
+      MappingRule = Struct.new(:metric_ref, :http_method, :pattern, :delta, :last)
+
+      attr_reader :cr
+
+      def initialize(cr)
+        @cr = cr
+      end
+
+      def system_name
+        cr.dig('spec', 'systemName')
+      end
+
+      def name
+        cr.dig('spec', 'name')
+      end
+
+      def description
+        cr.dig('spec', 'description')
+      end
+
+      def private_endpoint
+        cr.dig('spec', 'privateBaseURL')
+      end
+
+      def metrics
+        @metrics ||= (cr.dig('spec', 'metrics') || {}).map do |system_name, metric|
+          Metric.new(system_name, metric['friendlyName'], metric['description'], metric['unit'])
+        end
+      end
+
+      def methods
+        @methods ||= (cr.dig('spec', 'methods') || {}).map do |system_name, method|
+          Method.new(system_name, method['friendlyName'], method['description'])
+        end
+      end
+
+      def mapping_rules
+        @mapping_rules ||= (cr.dig('spec', 'mappingRules') || []).map do |mapping_rule|
+          MappingRule.new(mapping_rule['metricMethodRef'], mapping_rule['httpMethod'],
+            mapping_rule['pattern'], mapping_rule['increment'], mapping_rule['last'])
+        end
+      end
+
+      # Metrics and methods index by system_name
+      def metrics_index
+        @metrics_index ||= (methods + metrics).each_with_object({}) { |metric, h| h[metric.system_name] = metric }
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/backend_usage_dump.rb

@@ -0,0 +1,11 @@
+module ThreeScaleToolbox
+  module CRD
+    module BackendUsageSerializer
+      def to_cr
+        {
+          'path' => path
+        }
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/limit_dump.rb

@@ -0,0 +1,37 @@
+module ThreeScaleToolbox
+  module CRD
+    module Limit
+      def to_cr
+        {
+          'period' => period,
+          'value' => value,
+          'metricMethodRef' => metric_system_name,
+        }
+      end
+
+      def metric_system_name
+        # Find in service methods
+        # Find in service metrics
+        # Find in backend methods
+        # Find in backend metrics
+        if (method = plan.service.methods.find { |m| m.id == metric_id })
+          { 'systemName' => method.system_name }
+        elsif (metric = plan.service.metrics.find { |m| m.id == metric_id })
+          { 'systemName' => metric.system_name }
+        elsif (backend = backend_from_metric)
+          if (backend_metric = backend.metrics.find { |m| m.id == metric_id })
+            { 'systemName' => backend_metric.system_name, 'backend' => backend.system_name }
+          elsif (backend_method = backend.methods.find { |m| m.id == metric_id })
+            { 'systemName' => backend_method.system_name, 'backend' => backend.system_name }
+          else
+            raise ThreeScaleToolbox::Error, "Unexpected error. Limit #{id} " \
+              "referencing to metric id #{metric_id} which has not been found"
+          end
+        else
+          raise ThreeScaleToolbox::Error, "Unexpected error. Limit #{id} " \
+            "referencing to metric id #{metric_id} which has not been found"
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/crds/mapping_rule_dump.rb

@@ -0,0 +1,26 @@
+module ThreeScaleToolbox
+  module CRD
+    module MappingRuleSerializer
+      def to_cr
+        {
+          'httpMethod' => http_method,
+          'pattern' => pattern,
+          'metricMethodRef' => metric_method_ref,
+          'increment' => delta,
+          'last' => last,
+        }
+      end
+
+      def metric_method_ref
+        if (method = service.methods.find { |m| m.id == metric_id })
+          method.system_name
+        elsif (metric = service.metrics.find { |m| m.id == metric_id })
+          metric.system_name
+        else
+          raise ThreeScaleToolbox::Error, "Unexpected error. Service #{service.system_name} " \
+            "mapping rule #{id} referencing to metric id #{metric_id} which has not been found"
+        end
+      end
+    end
+  end
+end