3scale_toolbox 0.16.0 → 0.18.3

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

@@ -6,9 +6,24 @@ module ThreeScaleToolbox
           include Task
 
           def call
-            target.update_proxy source.proxy
+            target.update_proxy target_proxy_attrs
             target.update_oidc source.oidc if source.attrs['backend_version'] == 'oidc'
-            puts "updated proxy of #{target.id} to match the original"
+            logger.info "updated proxy of #{target.id} to match the original"
+          end
+
+          def target_proxy_attrs
+            if source.attrs['deployment_option'] == 'hosted'
+              # For services with "hosted" deployment config,
+              # "Public Base URL" should not be copied, mainly because public base URL is self-assigned.
+              # Two 3scale products (aka services) cannot be served using the same public base URL.
+              source_proxy.dup.delete_if { |key, _v| %w[endpoint sandbox_endpoint].include? key }
+            else
+              source_proxy
+            end
+          end
+
+          def source_proxy
+            @source_proxy ||= source.proxy
           end
         end
       end

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

@@ -25,7 +25,8 @@ module ThreeScaleToolbox
             # assign target service for other tasks to have it available
             self.target = service
 
-            puts "new service id #{service.id}"
+            logger.info "new service id #{service.id}"
+            report['product_id'] = service.id
           end
 
           private

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

@@ -12,10 +12,8 @@ module ThreeScaleToolbox
           def call
             return unless delete_mapping_rules
 
-            puts 'destroying all mapping rules'
-            target.mapping_rules.each do |mapping_rule|
-              target.delete_mapping_rule mapping_rule['id']
-            end
+            logger.info 'destroying all mapping rules'
+            target.mapping_rules.each(&:delete)
           end
 
           private
@@ -25,7 +23,13 @@ module ThreeScaleToolbox
           end
 
           def target
-            context[:target]
+            context.fetch(:target)
+          end
+
+          def logger
+            context[:logger] ||= Logger.new($stdout).tap do |logger|
+              logger.formatter = proc { |severity, datetime, progname, msg| "#{msg}\n" }
+            end
           end
         end
       end

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

@@ -36,44 +36,12 @@ module ThreeScaleToolbox
             context[:delete_mapping_rules] = true
           end
 
-          def source_metrics
-            context[:source_metrics] ||= source.metrics
-          end
-
-          def source_hits
-            context[:source_hits] ||= source.hits
-          end
-
-          def source_methods
-            context[:source_methods] ||= source.methods(source_hits.fetch('id'))
-          end
-
           def source_metrics_and_methods
-            source_metrics + source_methods
-          end
-
-          def target_metrics
-            context[:target_metrics] ||= target.metrics
-          end
-
-          def target_hits
-            context[:target_hits] ||= target.hits
-          end
-
-          def target_methods
-            context[:target_methods] ||= target.methods(target_hits.fetch('id'))
+            source.metrics + source.methods
           end
 
           def target_metrics_and_methods
-            target_metrics + target_methods
-          end
-
-          def invalidate_target_methods
-            context[:target_methods] = nil
-          end
-
-          def invalidate_target_metrics
-            context[:target_metrics] = nil
+            target.metrics + target.methods
           end
 
           def source_remote
@@ -92,6 +60,24 @@ module ThreeScaleToolbox
           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 plans_report
+            report['application_plans'] ||= {}
+          end
+
+          def activedocs_report
+            report['activedocs'] ||= {}
+          end
+
+          def report
+            context[:report] ||= {}
+          end
         end
       end
     end

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

@@ -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|

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

@@ -11,9 +11,9 @@ module ThreeScaleToolbox
           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
 
@@ -30,6 +30,7 @@ module ThreeScaleToolbox
         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))

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

@@ -11,9 +11,7 @@ module ThreeScaleToolbox
 
           def call
             puts 'deleting all target service ActiveDocs'
-            target.activedocs.each do |activedoc|
-              target.remote.delete_activedocs(activedoc['id'])
-            end
+            target.activedocs.each(&:delete)
           end
 
           def target

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