3scale_toolbox 0.19.3 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2a44bdf128bf6f8d4d0a592a4eee49c82c34415017e03366ff2bcc241fe18c0
-  data.tar.gz: 0e94df4747331e9092ae0c961709cfcc334a553eb54209378941b8239307eceb
+  metadata.gz: f688ec02bf32ca42f99e737b789e9826111d09417987fc0ef8bb32ee1719956b
+  data.tar.gz: '068391c70eeb07ddd450af05abe77c80e4b623c53383f5da6b75375d45cade58'
 SHA512:
-  metadata.gz: 8dd7a6efc6567598d87e4ebbc18c486eba1ea9e6766ca6c0241f78e73a4287408d9e18ac838788e81a073c8f3a8fd93d299fac4ea9f21a42571e3cff68f2b0bb
-  data.tar.gz: c4ed75a0b46414606208a5fb6e1374e72d5fe06fbb5a237b3793bc2471d20667c489acace51cdf93d4971bfe59b42dc2919631b90074a8af72bac1668c663d01
+  metadata.gz: 82fe4022c976594d2d8b52db9d84f0b1d8886738c3f076614864ddc34b48e24c62445c6fab34d25c9ce164176f19490c290bc3d97b5f8b913f1a57f20ee9a2d6
+  data.tar.gz: 9b24f6ee07f2209d1180ce57cf21096b6b9a2970c07539a4619c21dbcbc5700359a1b132539ece15668d9c6753a8858a89cb635ab491385f0f8e15d6388c389a

data/3scale_toolbox.gemspec

@@ -36,8 +36,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webmock', '~> 3.4'
   spec.required_ruby_version = '>= 2.6'
 
-  spec.add_dependency '3scale-api', '~> 1.4'
+  spec.add_dependency '3scale-api', '~> 1.6'
   spec.add_dependency 'cri', '~> 2.15'
   spec.add_dependency 'json-schema', '~> 2.8'
   spec.add_dependency 'oas_parser', '~> 0.20'
+  spec.add_dependency 'activesupport', '~> 6.0'
 end

data/README.md

@@ -2,6 +2,7 @@
 [![CircleCI](https://circleci.com/gh/3scale/3scale_toolbox.svg?style=svg)](https://circleci.com/gh/3scale/3scale_toolbox)
 [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
 [![GitHub release](https://img.shields.io/github/v/release/3scale/3scale_toolbox.svg)](https://github.com/3scale/3scale_toolbox/releases/latest)
+[![codecov](https://codecov.io/gh/3scale/3scale_toolbox/branch/main/graph/badge.svg?token=ojinl2NVv5)](https://codecov.io/gh/3scale/3scale_toolbox)
 
 ## Description
 3scale toolbox is a set of tools to help you manage your 3scale product. Using the [3scale API Ruby Client](https://github.com/3scale/3scale-api-ruby).
@@ -22,7 +23,8 @@
    * Create, Apply, List, Delete [Method](docs/method.md)
    * Create, Apply, List, Show, Delete [Service](docs/service.md)
    * Create, Apply, List, Delete [ActiveDocs](docs/activedocs.md)
-   * List, Show, Promote, Export, Deploy [Proxy Configuration](docs/proxy-config.md)
+   * Show, Update, Deploy [APIcast proxy settings](docs/proxy.md)
+   * List, Show, Promote, Export [Staging/Production Proxy Configuration](docs/proxy-config.md)
    * [Copy Policy Registry](docs/copy-policy-registry.md)
    * Create, Apply, List, Show, Delete, Suspend, Resume [Applications](docs/applications.md)
    * [Export/Import Product Policy Chain](docs/export-import-policy-chain.md)
@@ -82,16 +84,18 @@ COMMANDS
     import               import super command
     method               method super command
     metric               metric super command
+    policies             policies super command
     policy-registry      policy-registry super command
     product              product super command
+    proxy                proxy super command
     proxy-config         proxy-config super command
     remote               remotes super command
     service              services super command
-    update               [DEPRECATED] update super command
 
 OPTIONS
     -c --config-file=<value>      3scale toolbox configuration file (default:
                                   $HOME/.3scalerc.yaml)
+       --disable-keep-alive       Disable keep alive HTTP connection mode
     -h --help                     show help for this command
     -k --insecure                 Proceed and operate even for server
                                   connections otherwise considered insecure
@@ -173,7 +177,6 @@ Then register the core command in `lib/3scale_toolbox/commands.rb`
 +++ b/lib/3scale_toolbox/commands.rb
 @@ -4,6 +4,7 @@ require '3scale_toolbox/commands/copy_command'
  require '3scale_toolbox/commands/import_command'
- require '3scale_toolbox/commands/update_command'
  require '3scale_toolbox/commands/remote_command'
 +require '3scale_toolbox/commands/service_list_command'
 
@@ -182,7 +185,6 @@ Then register the core command in `lib/3scale_toolbox/commands.rb`
 @@ -12,7 +13,8 @@ module ThreeScaleToolbox
        ThreeScaleToolbox::Commands::CopyCommand,
        ThreeScaleToolbox::Commands::ImportCommand,
-       ThreeScaleToolbox::Commands::UpdateCommand,
 -      ThreeScaleToolbox::Commands::RemoteCommand::RemoteCommand
 +      ThreeScaleToolbox::Commands::RemoteCommand::RemoteCommand,
 +      ThreeScaleToolbox::Commands::ServiceListCommand

data/lib/3scale_toolbox/3scale_client_factory.rb

@@ -1,18 +1,19 @@
 module ThreeScaleToolbox
   class ThreeScaleClientFactory
     class << self
-      def get(remotes, remote_str, verify_ssl, verbose = false)
-        new(remotes, remote_str, verify_ssl, verbose).call
+      def get(remotes, remote_str, verify_ssl, verbose = false, keep_alive = true)
+        new(remotes, remote_str, verify_ssl, verbose, keep_alive).call
       end
     end
 
-    attr_reader :remotes, :remote_str, :verify_ssl, :verbose
+    attr_reader :remotes, :remote_str, :verify_ssl, :verbose, :keep_alive
 
-    def initialize(remotes, remote_str, verify_ssl, verbose)
+    def initialize(remotes, remote_str, verify_ssl, verbose, keep_alive)
       @remotes = remotes
       @remote_str = remote_str
       @verify_ssl = verify_ssl
       @verbose = verbose
+      @keep_alive = keep_alive
     end
 
     def call
@@ -22,15 +23,16 @@ module ThreeScaleToolbox
         remote = remotes.fetch(remote_str)
       end
 
-      client = remote_client(**remote.merge(verify_ssl: verify_ssl))
+      client = remote_client(**remote.merge(verify_ssl: verify_ssl, keep_alive: keep_alive))
       client = ProxyLogger.new(client) if verbose
       RemoteCache.new(client)
     end
 
     private
 
-    def remote_client(endpoint:, authentication:, verify_ssl:)
-      ThreeScale::API.new(endpoint: endpoint, provider_key: authentication, verify_ssl: verify_ssl)
+    def remote_client(endpoint:, authentication:, verify_ssl:, keep_alive:)
+      ThreeScale::API.new(endpoint: endpoint, provider_key: authentication,
+                          verify_ssl: verify_ssl, keep_alive: keep_alive)
     end
   end
 end

data/lib/3scale_toolbox/base_command.rb

@@ -46,7 +46,7 @@ module ThreeScaleToolbox
     # Input param can be endpoint url or remote name
     #
     def threescale_client(str)
-      ThreeScaleClientFactory.get(remotes, str, verify_ssl, verbose)
+      ThreeScaleClientFactory.get(remotes, str, verify_ssl, verbose, keep_alive)
     end
 
     def verify_ssl
@@ -58,6 +58,10 @@ module ThreeScaleToolbox
       options[:verbose]
     end
 
+    def keep_alive
+      !options[:'disable-keep-alive']
+    end
+
     def exit_with_message(message)
       raise ThreeScaleToolbox::Error, message
     end

data/lib/3scale_toolbox/cli/null_printer.rb

@@ -0,0 +1,11 @@
+module ThreeScaleToolbox
+  module CLI
+    class NullPrinter
+      def print_record(record)
+      end
+
+      def print_collection(collection)
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/cli.rb

@@ -1,4 +1,5 @@
 require '3scale_toolbox/cli/error_handler'
+require '3scale_toolbox/cli/null_printer'
 require '3scale_toolbox/cli/json_printer'
 require '3scale_toolbox/cli/yaml_printer'
 require '3scale_toolbox/cli/custom_table_printer'

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

@@ -17,6 +17,7 @@ module ThreeScaleToolbox
           end
           flag :k, :insecure, 'Proceed and operate even for server connections otherwise considered insecure'
           flag nil, :verbose, 'Verbose mode'
+          flag nil, :'disable-keep-alive', 'Disable keep alive HTTP connection mode'
           flag :h, :help, 'show help for this command' do |_, cmd|
             puts cmd.help
             exit 0

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

@@ -108,7 +108,7 @@ module ThreeScaleToolbox
 
           def read_activedocs_json_spec
             activedoc_spec = option_openapi_spec
-            activedoc_spec_content = load_resource(activedoc_spec)
+            activedoc_spec_content = load_resource(activedoc_spec, verify_ssl)
             JSON.pretty_generate(activedoc_spec_content)
           end
 

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

@@ -52,20 +52,19 @@ module ThreeScaleToolbox
           end
 
           def activedocs_json_spec
-            activedoc_spec = arguments[:activedocs_spec]
-            activedoc_spec_content = load_resource(arguments[:activedocs_spec])
+            activedoc_spec_content = load_resource(arguments[:activedocs_spec], verify_ssl)
             JSON.pretty_generate(activedoc_spec_content)
           end
 
           def activedocs_attrs
             {
-              "service_id" => options[:'service-id'],
-              "published" => options[:'published'],
-              "skip_swagger_validations" => options[:'skip-swagger-validations'],
-              "description" => options[:'description'],
-              "system_name" => options[:'system-name'],
-              "name" => activedocs_name,
-              "body" => activedocs_json_spec,
+              'service_id' => options[:'service-id'],
+              'published' => options[:'published'],
+              'skip_swagger_validations' => options[:'skip-swagger-validations'],
+              'description' => options[:'description'],
+              'system_name' => options[:'system-name'],
+              'name' => activedocs_name,
+              'body' => activedocs_json_spec,
             }.compact
           end
 

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

@@ -23,7 +23,7 @@ module ThreeScaleToolbox
                 unless ThreeScaleToolbox::Helper.system_name_already_taken_error? errors
 
               # if activedocs system_name exists, ignore error, update activedocs
-              puts 'Activedocs exists, update!'
+              logger.info 'Activedocs exists, update!'
               update_res = threescale_client.update_activedocs(find_activedocs_id, active_doc)
               raise ThreeScaleToolbox::Error, "ActiveDocs has not been updated. #{update_res['errors']}" unless update_res['errors'].nil?
             end

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

@@ -0,0 +1,21 @@
+module ThreeScaleToolbox
+  module Commands
+    module ImportCommand
+      module OpenAPI
+        class CreateBackendMappingRulesStep
+          include Step
+
+          def call
+            backend.mapping_rules.each(&:delete)
+
+            report['mapping_rules'] = {}
+            operations.each do |op|
+              b_m_r = Entities::BackendMappingRule.create(backend: backend, attrs: op.mapping_rule)
+              report['mapping_rules'][op.friendly_name] = op.mapping_rule
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module ThreeScaleToolbox
+  module Commands
+    module ImportCommand
+      module OpenAPI
+        class CreateBackendMethodsStep
+          include Step
+
+          def call
+            missing_operations.each do |op|
+              method = Entities::BackendMethod.create(backend: backend, attrs: op.method)
+              op.set(:metric_id, method.id)
+            end
+
+            existing_operations.each do |op|
+              method_attrs = methods_index.fetch(op.method['system_name']).attrs
+              method = Entities::BackendMethod.new(id: method_attrs.fetch('id'), backend: backend)
+              method.update(op.method)
+              op.set(:metric_id, method.id)
+            end
+          end
+
+          private
+
+          def methods_index
+            @methods_index ||= backend.methods.each_with_object({}) do |method, acc|
+              acc[method.system_name] = method
+            end
+          end
+
+          def missing_operations
+            operations.reject { |op| methods_index.key? op.method['system_name'] }
+          end
+
+          def existing_operations
+            operations.select { |op| methods_index.key? op.method['system_name'] }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+module ThreeScaleToolbox
+  module Commands
+    module ImportCommand
+      module OpenAPI
+        class CreateBackendStep
+          include Step
+
+          ##
+          # Creates backend with a given system_name
+          # If the backend already exists, update basic settings like name and description
+          def call
+            # Update backend and update context
+            self.backend = Entities::Backend.find_by_system_name(remote: threescale_client,
+                                                                 system_name: system_name)
+            if backend.nil?
+              # Create service and update context
+              self.backend = Entities::Backend.create(remote: threescale_client,
+                                                      attrs: create_attrs)
+            else
+              backend.update(update_attrs)
+            end
+
+            report['id'] = backend.id
+            report['system_name'] = backend.system_name
+            report['private_endpoint'] = backend.private_endpoint
+          end
+
+          private
+
+          def create_attrs
+            {
+              'name' => title,
+              'system_name' => system_name,
+              'description' => description,
+              'private_endpoint' => private_endpoint
+            }
+          end
+
+          def update_attrs
+            {
+              'name' => title,
+              'description' => description,
+              'private_endpoint' => private_endpoint
+            }
+          end
+
+          def system_name
+            target_system_name || title.downcase.gsub(/[^\w]/, '_')
+          end
+
+          def title
+            api_spec.title
+          end
+
+          def description
+            api_spec.description
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,10 +6,12 @@ module ThreeScaleToolbox
           include Step
 
           def call
+            report['mapping_rules'] = {}
             operations.each do |op|
               Entities::MappingRule.create(service: service,
                                            attrs: op.mapping_rule)
-              puts "Created #{op.http_method} #{op.pattern} endpoint"
+              logger.info "Created #{op.http_method} #{op.pattern} endpoint"
+              report['mapping_rules'][op.friendly_name] = op.mapping_rule
             end
           end
         end

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

@@ -16,11 +16,16 @@ module ThreeScaleToolbox
               # Create service and update context
               self.service = Entities::Service.create(remote: threescale_client,
                                                       service_params: service_settings)
-              puts "Created service id: #{service.id}, name: #{service_name}"
+              logger.info "Created service id: #{service.id}, name: #{service_name}"
             else
               service.update(service_settings)
-              puts "Updated service id: #{service.id}, name: #{service_name}"
+              logger.info "Updated service id: #{service.id}, name: #{service_name}"
             end
+
+            report['id'] = service.id
+            report['system_name'] = service.system_name
+            report['name'] = service.name
+            report['backend_version'] = api_spec.service_backend_version
           end
 
           private

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

@@ -0,0 +1,31 @@
+module ThreeScaleToolbox
+  module Commands
+    module ImportCommand
+      module OpenAPI
+        class ImportBackendStep
+          include Step
+
+          def call
+            verify_params
+
+            tasks = []
+            tasks << CreateBackendStep.new(context)
+            tasks << CreateBackendMethodsStep.new(context)
+            tasks << CreateBackendMappingRulesStep.new(context)
+
+            # run tasks
+            tasks.each(&:call)
+          end
+
+          private
+
+          def verify_params
+            if private_endpoint.nil?
+              raise ThreeScaleToolbox::Error, 'private endpoint not specified'
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module ThreeScaleToolbox
+  module Commands
+    module ImportCommand
+      module OpenAPI
+        class ImportProductStep
+          include Step
+
+          def call
+            tasks = []
+            tasks << CreateServiceStep.new(context)
+            # other tasks might read proxy settings (CreateActiveDocsStep does)
+            tasks << UpdateServiceProxyStep.new(context)
+            tasks << CreateMethodsStep.new(context)
+            tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::DestroyMappingRulesTask.new(context)
+            tasks << CreateMappingRulesStep.new(context)
+            tasks << CreateActiveDocsStep.new(context)
+            tasks << UpdateServiceOidcConfStep.new(context)
+            tasks << UpdatePoliciesStep.new(context)
+
+            # run tasks
+            tasks.each(&:call)
+
+            # This should be the last step
+            ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::BumpProxyVersionTask.new(service: context[:target]).call
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -12,7 +12,7 @@ module ThreeScaleToolbox
           end
 
           def friendly_name
-            operation[:operationId] || operation_id
+            operation[:operation_id] || operation_id
           end
 
           def system_name

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

@@ -9,6 +9,18 @@ module ThreeScaleToolbox
             @context = context
           end
 
+          def report
+            context[:report] ||= {}
+          end
+
+          def backend
+            context[:backend_target]
+          end
+
+          def backend=(backend_obj)
+            context[:backend_target] = backend_obj
+          end
+
           # Can be nil on initialization time and not nil afterwards
           # method to fetch from context required
           def service
@@ -41,7 +53,7 @@ module ThreeScaleToolbox
                 public_base_path: public_base_path,
                 path: op[:path],
                 verb: op[:verb],
-                operationId: op[:operation_id],
+                operation_id: op[:operation_id],
                 description: op[:description],
                 prefix_matching: prefix_matching,
               )
@@ -101,6 +113,16 @@ module ThreeScaleToolbox
             context[:prefix_matching]
           end
 
+          def private_endpoint
+            override_private_base_url || host
+          end
+
+          def host
+            return if api_spec.host.nil?
+
+            "#{api_spec.scheme || 'https'}://#{api_spec.host}"
+          end
+
           def base_path
             api_spec.base_path || '/'
           end
@@ -112,6 +134,10 @@ module ThreeScaleToolbox
           def private_base_path
             override_private_basepath || base_path
           end
+
+          def logger
+            context[:logger]
+          end
         end
       end
     end

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

@@ -26,7 +26,7 @@ module ThreeScaleToolbox
               raise ThreeScaleToolbox::Error, "Service policies have not been updated. #{errors}"
             end
 
-            puts 'Service policies updated'
+            logger.info 'Service policies updated'
           end
 
           private

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

@@ -20,7 +20,7 @@ module ThreeScaleToolbox
               raise ThreeScaleToolbox::Error, "Service oidc has not been updated. #{errors}"
             end
 
-            puts 'Service oidc updated'
+            logger.info 'Service oidc updated'
           end
 
           private

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

@@ -22,7 +22,7 @@ module ThreeScaleToolbox
               raise ThreeScaleToolbox::Error, "Service proxy has not been updated. #{errors}"
             end
 
-            puts 'Service proxy updated'
+            logger.info 'Service proxy updated'
           end
 
           private
@@ -31,12 +31,14 @@ module ThreeScaleToolbox
             return if production_public_base_url.nil?
 
             settings[:endpoint] = production_public_base_url
+            report['endpoint'] = production_public_base_url
           end
 
           def add_sandbox_endpoint_settings(settings)
             return if staging_public_base_url.nil?
 
             settings[:sandbox_endpoint] = staging_public_base_url
+            report['sandbox_endpoint'] = staging_public_base_url
           end
 
           def add_api_backend_settings(settings)
@@ -74,13 +76,7 @@ module ThreeScaleToolbox
           end
 
           def private_base_url
-            override_private_base_url || private_base_url_from_openapi
-          end
-
-          def private_base_url_from_openapi
-            return if api_spec.host.nil?
-
-            "#{api_spec.scheme || 'https'}://#{api_spec.host}"
+            override_private_base_url || host
           end
         end
       end