xapixctl 1.1.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb39c7aace95b6c10168b43e536b404a8d5edcdfc48d12890b296708199dccda
-  data.tar.gz: 5db98915dd0ac3f1c02b64ceee8ba7497a72fe4ccd65c09c2543aa108a4a1b95
+  metadata.gz: afb1bf2d6f83193e0b5d1341fbfc1177c7c76802a2aa0cdef748f3d9eb0e7d11
+  data.tar.gz: 742c9ce8f28477d6bf922196c1d0d192ec1648db7fbe1cc73a1aba673c307f2d
 SHA512:
-  metadata.gz: d67fe8ecd7b977fd05c7f8f8fb9b2b0fdbd4b1153405f0419f93bf05eea7dcb77d4314f4a635d77cb8472c50fcdef9c92df5fae1e361a8874b33401968dfaa35
-  data.tar.gz: e44e46596d4b155a5e3e5c08772de09fdbac68d1b5de23c6377a448f75af35c3701e59cf25498491d57c1c5418b3340ec7098939d168063f0c18bbe929c532d7
+  metadata.gz: 87ecb583e67e5210f5cc9c2333d519e6bc160b7e0d8eb5236c407825acca54fc0dd1bfac178d2f0abef4becd29e5cc4b46bdc1d6e0c4ffcda79ab969a2d5846f
+  data.tar.gz: 5ee3f1ef369eb548117d7e277884348ea9cc4885f650bae9c3bb4191a72e7f4d3261ceb05b97f53ca2ee04c2a917fbd2937e96d024b4e4a690d3a0fe37926d80

data/.github/workflows/cd.yaml

@@ -0,0 +1,17 @@
+name: CD
+on: push
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [2.7, 2.6]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+2.6.3

data/Gemfile.lock

@@ -1,40 +1,46 @@
 PATH
   remote: .
   specs:
-    xapixctl (1.1.1)
+    xapixctl (1.2.3)
       activesupport (>= 5.2.3, < 6.0.0)
+      hashdiff (>= 1.0.1, < 1.2.0)
       rest-client (>= 2.1.0, < 3.0.0)
-      thor (>= 1.0.0, < 1.1.0)
+      thor (>= 1.0.0, < 1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.4.4)
+    activesupport (5.2.4.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    ast (2.4.1)
-    concurrent-ruby (1.1.7)
-    diff-lcs (1.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.8)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    hashdiff (1.0.1)
     http-accept (1.7.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    i18n (1.8.5)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0512)
-    minitest (5.14.2)
+    mime-types-data (3.2021.0225)
+    minitest (5.14.4)
     netrc (0.11.0)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
       ast (~> 2.4.1)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.8.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
     relaxed-rubocop (2.5)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
@@ -42,50 +48,62 @@ GEM
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
     rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.91.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.11.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.4.0, < 1.0)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.4.2)
-      parser (>= 2.7.1.4)
-    ruby-progressbar (1.10.1)
-    thor (1.0.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    thor (1.1.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.7)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.7)
-    unicode-display_width (1.7.0)
+    unicode-display_width (2.0.0)
+    webmock (3.11.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17.3)
+  bundler (~> 2.1.4)
   rake (~> 13.0)
   relaxed-rubocop (~> 2.5)
-  rspec (~> 3.0)
-  rubocop (~> 0.89)
+  rspec (~> 3.10.0)
+  rubocop (~> 1.11.0)
+  rubocop-rake (~> 0.5.1)
+  rubocop-rspec (~> 2.2.0)
+  webmock (~> 3.11.0)
   xapixctl!
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/lib/xapixctl.rb

@@ -4,9 +4,6 @@ require 'active_support'
 require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/string/inflections'
-require 'rest_client'
-require 'json'
-require 'psych'
 require 'xapixctl/version'
 require 'xapixctl/phoenix_client'
 

data/lib/xapixctl/base_cli.rb

@@ -1,20 +1,30 @@
 # frozen_string_literal: true
 
 require 'thor'
+require 'xapixctl/util'
 
 module Xapixctl
   class BaseCli < Thor
     def self.exit_on_failure?; true; end
 
-    class_option :verbose, type: :boolean, aliases: "-v"
+    def self.start(given_args = ARGV, config = {})
+      super
+    rescue StandardError => err
+      config[:debug] || ENV["THOR_DEBUG"] == "1" ? (raise err) : config[:shell].error(err.message)
+      exit(false) if exit_on_failure?
+    end
+
+    class_option :org, aliases: "-o", desc: "Organization; Fallback: environment variable XAPIX_ORG"
+    class_option :project, aliases: "-p", desc: "Project, can be ORG/PROJECT; Fallback: environment variable XAPIX_PROJECT"
+    class_option :debug, type: :boolean, desc: "Print details for debugging"
     class_option :xapix_url, desc: "Fallback: environment variable XAPIX_URL. URL to Xapix. Default: https://cloud.xapix.io/"
     class_option :xapix_token, desc: "Fallback: environment variable XAPIX_TOKEN. Your access token."
 
     private
 
-    def warn_api_error(text, err, result)
-      details = "\n " + result['errors'].map { |k| k['detail'] }.join("\n ") rescue err.to_s
-      warn "#{text}: #{details}"
+    def exit_with_api_error(err, result)
+      details = result['errors'].map { |k| k['detail'] }.unshift('').join("\n ") rescue err.to_s
+      warn "API error: #{details}"
       exit 1
     end
 
@@ -28,24 +38,38 @@ module Xapixctl
       end
     end
 
-    DOCUMENT_STRUCTURE = %w[version kind metadata definition].freeze
-    def resources_from_file(filename)
-      yaml_string = filename == '-' ? $stdin.read : IO.read(filename)
-      yaml_string.split(/^---\s*\n/).map { |yml| Psych.safe_load(yml) }.compact.each do |doc|
-        unless (DOCUMENT_STRUCTURE - doc.keys.map(&:to_s)).empty?
-          warn "does not look like a correct resource definition:"
-          warn doc.inspect
-          exit 1
-        end
-        yield doc
+    def connection
+      @connection ||= begin
+        url = options[:xapix_url] || ENV['XAPIX_URL'] || 'https://cloud.xapix.io/'
+        token = options[:xapix_token] || ENV['XAPIX_TOKEN']
+        raise Thor::RequiredArgumentMissingError, "No XAPIX_TOKEN given. Either use --xapix_token [TOKEN] or set environment variable XAPIX_TOKEN (recommended)" if !token
+        PhoenixClient.connection(
+          url, token,
+          default_error_handler: ->(err, result) { exit_with_api_error(err, result) },
+          logging: options[:debug] ? 'stdout' : nil
+        )
       end
     end
 
-    def connection
-      url = options[:xapix_url] || ENV['XAPIX_URL'] || 'https://cloud.xapix.io/'
-      token = options[:xapix_token] || ENV['XAPIX_TOKEN']
-      raise Thor::RequiredArgumentMissingError, "no XAPIX_TOKEN given. Either use --xapix_token [TOKEN] or set environment variable XAPIX_TOKEN (recommended)" if !token
-      PhoenixClient::Connection.new(url, token)
+    def org_or_prj_connection
+      options[:project] ? prj_connection : org_connection
+    end
+
+    def org_connection
+      org = options[:org] || ENV['XAPIX_ORG']
+      raise Thor::RequiredArgumentMissingError, "No organization given. Either use --org [ORG] or set environment variable XAPIX_ORG" if !org
+      @org_connection ||= connection.organization(org)
+    end
+
+    def prj_connection
+      project = options[:project] || ENV['XAPIX_PROJECT']
+      org = options[:org] || ENV['XAPIX_ORG']
+      raise Thor::RequiredArgumentMissingError, "No project given. Either use --project [ORG/PROJECT] or set environment variable XAPIX_PROJECT" if !project
+      if project.include?('/')
+        org, project = project.split('/', 2)
+      end
+      raise Thor::RequiredArgumentMissingError, "No organization given. Either use --org [ORG] or set environment variable XAPIX_ORG" if !org
+      @prj_connection ||= connection.project(org: org, project: project)
     end
   end
 end

data/lib/xapixctl/cli.rb

@@ -1,25 +1,35 @@
 # frozen_string_literal: true
 
 require 'xapixctl/base_cli'
+require 'xapixctl/connector_cli'
 require 'xapixctl/preview_cli'
+require 'xapixctl/sync_cli'
+require 'xapixctl/titan_cli'
 
 module Xapixctl
   class Cli < BaseCli
+    desc "connectors SUBCOMMAND ...ARGS", "Commands for Connector resources"
+    subcommand "connectors", ConnectorCli
+
     desc "preview SUBCOMMAND ...ARGS", "Request preview for resources"
-    subcommand "preview", Preview
+    subcommand "preview", PreviewCli
+
+    desc "sync SUBCOMMAND ...ARGS", "Sync resources"
+    subcommand "sync", SyncCli
+
+    desc "titan SUBCOMMAND ...ARGS", "Tools for ML model deployments and service generation", hide: true
+    subcommand "titan", TitanCli
 
-    option :org, aliases: "-o", desc: "Organization", required: true
-    option :project, aliases: "-p", desc: "Project"
     option :format, aliases: "-f", default: 'text', enum: ['text', 'yaml', 'json'], desc: "Output format"
     desc "get TYPE [ID]", "retrieve either all resources of given TYPE or just the resource of given TYPE and ID"
     long_desc <<-LONGDESC
       `xapixctl get TYPE` will retrieve the list of all resources of given type.
 
       If requested on an organization (i.e. no project given), the following types are available:
-      \x5 Project
+      \x5Project
 
       If requested on an a project (i.e. organization and project are given), the following types are available:
-      \x5 Ambassador, AuthScheme, CacheConnection, Credential, DataSource, Endpoint, EndpointGroup, Proxy, Schema, Stream, StreamGroup
+      \x5#{PhoenixClient::SUPPORTED_RESOURCE_TYPES.sort.join(', ')}
 
       Use the format to switch between the different output formats.
 
@@ -27,31 +37,17 @@ module Xapixctl
       \x5> $ xapixctl get -o xapix Project
       \x5> $ xapixctl get -o xapix Project some-project
       \x5> $ xapixctl get -o xapix -p some-project DataSource
-      \x5> $ xapixctl get -o xapix -p some-project DataSource get-a-list
+      \x5> $ xapixctl get -p xapix/some-project DataSource
+      \x5> $ xapixctl get -p xapix/some-project DataSource get-a-list
     LONGDESC
     def get(resource_type, resource_id = nil)
-      if resource_id
-        connection.resource(resource_type, resource_id, org: options[:org], project: options[:project], format: options[:format].to_sym) do |res|
-          res.on_success { |resource| puts resource }
-          res.on_error { |err, result| warn_api_error("could not get", err, result) }
-        end
-      else
-        connection.resource_ids(resource_type, org: options[:org], project: options[:project]) do |res|
-          res.on_success do |resource_ids|
-            resource_ids.each do |resource_id|
-              connection.resource(resource_type, resource_id, org: options[:org], project: options[:project], format: options[:format].to_sym) do |res|
-                res.on_success { |resource| puts resource }
-                res.on_error { |err, result| warn_api_error("could not get", err, result) }
-              end
-            end
-          end
-          res.on_error { |err, result| warn_api_error("could not get", err, result) }
-        end
+      conn = org_or_prj_connection
+      resource_ids = resource_id ? [resource_id] : conn.resource_ids(resource_type)
+      resource_ids.each do |res_id|
+        puts conn.resource(resource_type, res_id, format: options[:format].to_sym)
       end
     end
 
-    option :org, aliases: "-o", desc: "Organization", required: true
-    option :project, aliases: "-p", desc: "Project", required: true
     option :format, aliases: "-f", default: 'text', enum: ['text', 'yaml', 'json'], desc: "Output format"
     desc "export", "retrieves all resources within a project"
     long_desc <<-LONGDESC
@@ -61,19 +57,15 @@ module Xapixctl
 
       Examples:
       \x5> $ xapixctl export -o xapix -p some-project
-      \x5> $ xapixctl export -o xapix -p some-project -f yaml > some_project.yaml
+      \x5> $ xapixctl export -p xapix/some-project
+      \x5> $ xapixctl export -p xapix/some-project -f yaml > some_project.yaml
     LONGDESC
     def export
-      connection.resource('Project', options[:project], org: options[:org], format: options[:format].to_sym) do |res|
-        res.on_success { |resource| puts resource }
-        res.on_error { |err, result| warn_api_error("could not get", err, result) }
-      end
-      (connection.resource_types_for_export - ['Project']).each { |type| get(type) }
+      get('Project', prj_connection.project)
+      prj_connection.resource_types_for_export.each { |type| get(type) }
     end
 
-    option :org, aliases: "-o", desc: "Organization", required: true
-    option :project, aliases: "-p", desc: "Project"
-    option :file, aliases: "-f", required: true
+    option :file, aliases: "-f", required: true, desc: 'file or directory from which to load resource descriptions'
     desc "apply", "Create or update a resource from a file"
     long_desc <<-LONGDESC
       `xapixctl apply -f FILE` will apply the given resource description.
@@ -83,80 +75,72 @@ module Xapixctl
       If applied on a project (i.e. organization and project are given), the given project is used.
 
       The given file should be in YAML format and can contain multiple resource definitions, each as it's own YAML document.
+      You can also provide a directory, in which case all files with yml/yaml extension will get loaded.
       You can also read from stdin by using '-'.
 
       Examples:
       \x5> $ xapixctl apply -o xapix -f get_a_list.yaml
       \x5> $ xapixctl apply -o xapix -p some-project -f get_a_list.yaml
+      \x5> $ xapixctl apply -p xapix/some-project -f get_a_list.yaml
+      \x5> $ xapixctl apply -p xapix/some-project -f ./
 
       To copy over all data sources from one project to another:
       \x5> $ xapixctl get -o xapix-old -p some-project DataSource -f yaml | xapixctl apply -o xapix-new -f -
     LONGDESC
     def apply
-      resources_from_file(options[:file]) do |desc|
+      Util.resources_from_file(options[:file]) do |desc|
         puts "applying #{desc['kind']} #{desc.dig('metadata', 'id')}"
-        connection.apply(desc, org: options[:org], project: options[:project]) do |res|
-          res.on_success { puts 'OK' }
-          res.on_error { |err, result| warn_api_error("could not apply changes", err, result); break }
-        end
+        org_or_prj_connection.apply(desc)
       end
     end
 
-    option :org, aliases: "-o", desc: "Organization", required: true
-    option :project, aliases: "-p", desc: "Project"
-    option :file, aliases: "-f"
+    option :file, aliases: "-f", desc: 'file or directory from which to load resource descriptions'
     desc "delete [TYPE ID] [-f FILE]", "delete the resources in the file"
     long_desc <<-LONGDESC
       `xapixctl delete -f FILE` will delete all the resources listed in the file.
       \x5`xapixctl delete TYPE ID` will delete the resource by given TYPE and ID.
 
       The given file should be in YAML format and can contain multiple resource definitions, each as it's own YAML document.
+      You can also provide a directory, in which case all files with yml/yaml extension will get loaded.
       You can also read from stdin by using '-'.
 
       Examples:
-      \x5> $ xapixctl delete -o xapix -p some-project -f get_a_list.yaml
-      \x5> $ xapixctl delete -o xapix -p some-project DataSource get-a-list
       \x5> $ xapixctl delete -o xapix Project some-project
+      \x5> $ xapixctl delete -p xapix -p some-project DataSource get-a-list
+      \x5> $ xapixctl delete -p xapix/some-project DataSource get-a-list
+      \x5> $ xapixctl delete -p xapix/some-project -f get_a_list.yaml
+      \x5> $ xapixctl delete -p xapix/some-project -f ./
     LONGDESC
     def delete(resource_type = nil, resource_id = nil)
       if resource_type && resource_id
-        connection.delete(resource_type, resource_id, org: options[:org], project: options[:project]) do |res|
-          res.on_success { puts 'DELETED' }
-          res.on_error { |err, result| warn_api_error("could not delete", err, result) }
-        end
+        org_or_prj_connection.delete(resource_type, resource_id)
+        puts "DELETED #{resource_type} #{resource_id}"
       elsif options[:file]
-        resources_from_file(options[:file]) do |desc|
-          type = desc['kind']
-          id = desc.dig('metadata', 'id')
-          puts "deleting #{type} #{id}"
-          connection.delete(type, id, org: options[:org], project: options[:project]) do |res|
-            res.on_success { puts "DELETED #{type} #{id}" }
-            res.on_error { |err, result| warn_api_error("could not delete", err, result); break }
-          end
+        Util.resources_from_file(options[:file]) do |desc|
+          res_type = desc['kind']
+          res_id = desc.dig('metadata', 'id')
+          delete(res_type, res_id)
         end
       else
         warn "need TYPE and ID or --file option"
       end
     end
 
-    option :org, aliases: "-o", desc: "Organization", required: true
-    option :project, aliases: "-p", desc: "Project", required: true
     desc "publish", "Publishes the current version of the given project"
     long_desc <<-LONGDESC
       `xapixctl publish` will publish the given project.
 
       Examples:
       \x5> $ xapixctl publish -o xapix -p some-project
+      \x5> $ xapixctl publish -p xapix/some-project
     LONGDESC
     def publish
-      connection.publish(org: options[:org], project: options[:project]) do |res|
+      prj_connection.publish do |res|
         res.on_success { |result| show_deployment_status(result) }
-        res.on_error { |err, result| show_deployment_status(result); warn_api_error('errors', err, result) }
+        res.on_error { |err, result| show_deployment_status(result); exit_with_api_error(err, result) }
       end
     end
 
-    option :org, aliases: "-o", desc: "Organization", required: true
-    option :project, aliases: "-p", desc: "Project", required: true
     desc "logs CORRELATION_ID", "Retrieves the execution logs for the given correlation ID"
     long_desc <<-LONGDESC
       `xapixctl logs CORRELATION_ID` will retrieve execution logs for the given correlation ID.
@@ -165,27 +149,23 @@ module Xapixctl
 
       Examples:
       \x5> $ xapixctl logs be9c8608-e291-460d-bc20-5a394c4079d4 -o xapix -p some-project
+      \x5> $ xapixctl logs be9c8608-e291-460d-bc20-5a394c4079d4 -p xapix/some-project
     LONGDESC
     def logs(correlation_id)
-      connection.logs(correlation_id, org: options[:org], project: options[:project]) do |res|
-        res.on_success { |result| puts result['logs'].to_yaml }
-        res.on_error { |err, result| warn_api_error('could not get logs', err, result) }
-      end
+      result = prj_connection.logs(correlation_id)
+      puts result['logs'].to_yaml
     end
 
     SUPPORTED_CONTEXTS = ['Project', 'Organization'].freeze
+
     desc "api-resources", "retrieves a list of all available resource types"
     def api_resources
-      connection.available_resource_types do |res|
-        res.on_success do |available_types|
-          format_str = "%20.20s %20.20s"
-          puts format_str % ['Type', 'Required Context']
-          available_types.sort_by { |desc| desc['type'] }.each do |desc|
-            next unless SUPPORTED_CONTEXTS.include?(desc['context'])
-            puts format_str % [desc['type'], desc['context']]
-          end
-        end
-        res.on_error { |err, result| warn_api_error("could not get", err, result) }
+      available_types = connection.available_resource_types
+      format_str = "%20.20s %20.20s %26.26s"
+      puts format_str % ['Type', 'Required Context', '']
+      available_types.sort_by { |desc| desc['type'] }.each do |desc|
+        next unless SUPPORTED_CONTEXTS.include?(desc['context'])
+        puts format_str % [desc['type'], desc['context'], PhoenixClient.supported_type?(desc['type']) ? '' : '(unsupported, update CLI)']
       end
     end
   end