xapixctl 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3735380aedfe9b2b343be8035f2d988225e1ab686c8b861343a7872b74856b86
-  data.tar.gz: 134e2c3c03e630fddda6dfdc266b51716c6e239989d24a8af4d0e495f8b80ba0
+  metadata.gz: c745d574b6c72e52ff4a74989ac0b4663c6707e9dbd3c14e69facac3e135a978
+  data.tar.gz: 042e00431dc81a64d68d3a3b61af8b54b4319133144a4ba3916d26ad6a32a423
 SHA512:
-  metadata.gz: 5ad8cc281b69dd9a42b9f4b335b36bcde452888cd75896a4841af22957ce6631adccca781192919e16996a4c550def367de43b9b05d70c9fcddf303a436c29ce
-  data.tar.gz: 4730232765f508b57a332486a29abb543af26f0592471f1304d4e34a05491497d95ba04d737708cdf10085281293a5dda5a0edaf256fa4fa5d6f0f73052cadd3
+  metadata.gz: 34c8479e26148a0e158f20e9202340dc65dd84a85d624498f9e0b07994b1964257f5ab3d1b8db5fbc7304d4800ccb1672570f1beaffd857f7443c654d986cb63
+  data.tar.gz: 7071a6a8a53d41b41eec96af9ba05c58446c56ceb3be73148b619e3c33ac44d6da75b45b4192e0f5d1a4d547903ec98fbd2f87431ab5082cb659e456e827d39b

data/.github/workflows/cd.yaml

@@ -0,0 +1,19 @@
+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: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/.ruby-version

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

data/Gemfile.lock

@@ -1,40 +1,45 @@
 PATH
   remote: .
   specs:
-    xapixctl (1.1.2)
+    xapixctl (1.2.0)
       activesupport (>= 5.2.3, < 6.0.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)
+    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.5)
+    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 +47,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.92.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.11.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      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.5.0)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.5.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
-    ruby-progressbar (1.10.1)
-    thor (1.0.1)
+    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)
+  rubocop (~> 1.11)
+  rubocop-rake
+  rubocop-rspec
+  webmock
   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,23 @@
 # frozen_string_literal: true
 
 require 'thor'
+require 'pathname'
 
 module Xapixctl
   class BaseCli < Thor
     def self.exit_on_failure?; true; end
 
-    class_option :verbose, type: :boolean, aliases: "-v"
+    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
     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)
+    def exit_with_api_error(err, result)
       details = result['errors'].map { |k| k['detail'] }.unshift('').join("\n ") rescue err.to_s
-      warn "#{text}: #{details}"
+      warn "API error: #{details}"
       exit 1
     end
 
@@ -29,8 +32,8 @@ module Xapixctl
     end
 
     DOCUMENT_STRUCTURE = %w[version kind metadata definition].freeze
-    def resources_from_file(filename)
-      load_files(filename) do |yaml_string|
+    def resources_from_file(filename, ignore_missing: false)
+      load_files(filename, ignore_missing) do |yaml_string|
         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:"
@@ -42,24 +45,54 @@ module Xapixctl
       end
     end
 
-    def load_files(filename)
+    def load_files(filename, ignore_missing)
       if filename == '-'
         yield $stdin.read
       else
-        pn = Pathname.new(filename)
+        pn = filename.is_a?(Pathname) ? filename : Pathname.new(filename)
         if pn.directory?
           pn.glob(["**/*.yaml", "**/*.yml"]).sort.each { |dpn| yield dpn.read }
-        else
+        elsif pn.exist?
           yield pn.read
+        elsif !ignore_missing
+          warn "file not found: #{filename}"
+          exit 1
         end
       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)
+      @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 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

@@ -2,24 +2,26 @@
 
 require 'xapixctl/base_cli'
 require 'xapixctl/preview_cli'
+require 'xapixctl/sync_cli'
 
 module Xapixctl
   class Cli < BaseCli
     desc "preview SUBCOMMAND ...ARGS", "Request preview for resources"
     subcommand "preview", Preview
 
-    option :org, aliases: "-o", desc: "Organization", required: true
-    option :project, aliases: "-p", desc: "Project"
+    desc "sync SUBCOMMAND ...ARGS", "Sync resources"
+    subcommand "sync", Sync
+
     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,24 +29,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 { |resource_ids| resource_ids.each { |res_id| get(resource_type, res_id) } }
-          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
@@ -54,19 +49,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.
@@ -82,7 +73,8 @@ module Xapixctl
       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 -o xapix -p some-project -f ./
+      \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 -
@@ -90,16 +82,11 @@ module Xapixctl
     def apply
       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.
@@ -110,22 +97,20 @@ module Xapixctl
       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 -f ./
-      \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 #{resource_type} #{resource_id}" }
-          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|
           res_type = desc['kind']
           res_id = desc.dig('metadata', 'id')
-          puts "deleting #{res_type} #{res_id}"
           delete(res_type, res_id)
         end
       else
@@ -133,24 +118,21 @@ module Xapixctl
       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.
@@ -159,27 +141,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