xapixctl 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c745d574b6c72e52ff4a74989ac0b4663c6707e9dbd3c14e69facac3e135a978
-  data.tar.gz: 042e00431dc81a64d68d3a3b61af8b54b4319133144a4ba3916d26ad6a32a423
+  metadata.gz: 175a3c54493e14738757b5eb95ef1da9724b961f460d1ac5dfb17ea6eb696507
+  data.tar.gz: 0a79951ab81a2b69d0087161191097cf24b01e2282887d03b12e8f32527d3707
 SHA512:
-  metadata.gz: 34c8479e26148a0e158f20e9202340dc65dd84a85d624498f9e0b07994b1964257f5ab3d1b8db5fbc7304d4800ccb1672570f1beaffd857f7443c654d986cb63
-  data.tar.gz: 7071a6a8a53d41b41eec96af9ba05c58446c56ceb3be73148b619e3c33ac44d6da75b45b4192e0f5d1a4d547903ec98fbd2f87431ab5082cb659e456e827d39b
+  metadata.gz: 040c017fb340670f8751a45c5b9c0c659cd814bb712cc74fb40e368f714fb1b80759d9c4387cbbb19999cfd512fc389a082168cde33f67cc1fd9fa0fb17b42f3
+  data.tar.gz: 1bdbbbb3da472ade7b520cfebc284ebebdeb871ee77c3bafa5fb22789bf4c0057d4dc7ff116ee3c0d611dbd692d99a96ac168ffa8824be006b22b124c7e98bf7

data/.github/workflows/cd.yaml

@@ -13,7 +13,5 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true
-      - name: Install dependencies
-        run: bundle install
       - name: Run tests
         run: bundle exec rspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    xapixctl (1.2.0)
+    xapixctl (1.2.1)
       activesupport (>= 5.2.3, < 6.0.0)
       rest-client (>= 2.1.0, < 3.0.0)
       thor (>= 1.0.0, < 1.2.0)
@@ -97,11 +97,11 @@ DEPENDENCIES
   bundler (~> 2.1.4)
   rake (~> 13.0)
   relaxed-rubocop (~> 2.5)
-  rspec (~> 3.0)
-  rubocop (~> 1.11)
-  rubocop-rake
-  rubocop-rspec
-  webmock
+  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

data/lib/xapixctl/base_cli.rb

@@ -1,15 +1,22 @@
 # frozen_string_literal: true
 
 require 'thor'
-require 'pathname'
+require 'xapixctl/util'
 
 module Xapixctl
   class BaseCli < Thor
     def self.exit_on_failure?; true; end
 
+    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
+    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."
 
@@ -31,36 +38,6 @@ module Xapixctl
       end
     end
 
-    DOCUMENT_STRUCTURE = %w[version kind metadata definition].freeze
-    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:"
-            warn doc.inspect
-            exit 1
-          end
-          yield doc
-        end
-      end
-    end
-
-    def load_files(filename, ignore_missing)
-      if filename == '-'
-        yield $stdin.read
-      else
-        pn = filename.is_a?(Pathname) ? filename : Pathname.new(filename)
-        if pn.directory?
-          pn.glob(["**/*.yaml", "**/*.yml"]).sort.each { |dpn| yield dpn.read }
-        elsif pn.exist?
-          yield pn.read
-        elsif !ignore_missing
-          warn "file not found: #{filename}"
-          exit 1
-        end
-      end
-    end
-
     def connection
       @connection ||= begin
         url = options[:xapix_url] || ENV['XAPIX_URL'] || 'https://cloud.xapix.io/'

data/lib/xapixctl/cli.rb

@@ -7,10 +7,10 @@ require 'xapixctl/sync_cli'
 module Xapixctl
   class Cli < BaseCli
     desc "preview SUBCOMMAND ...ARGS", "Request preview for resources"
-    subcommand "preview", Preview
+    subcommand "preview", PreviewCli
 
     desc "sync SUBCOMMAND ...ARGS", "Sync resources"
-    subcommand "sync", Sync
+    subcommand "sync", SyncCli
 
     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"
@@ -80,7 +80,7 @@ module Xapixctl
       \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')}"
         org_or_prj_connection.apply(desc)
       end
@@ -108,7 +108,7 @@ module Xapixctl
         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|
+        Util.resources_from_file(options[:file]) do |desc|
           res_type = desc['kind']
           res_id = desc.dig('metadata', 'id')
           delete(res_type, res_id)

data/lib/xapixctl/preview_cli.rb

@@ -3,7 +3,7 @@
 require 'xapixctl/base_cli'
 
 module Xapixctl
-  class Preview < BaseCli
+  class PreviewCli < BaseCli
     option :format, aliases: "-f", default: 'text', enum: ['text', 'yaml', 'json'], desc: "Output format"
     desc "pipeline ID", "Preview a pipeline"
     long_desc <<-LONGDESC

data/lib/xapixctl/sync_cli.rb

@@ -1,62 +1,73 @@
 # frozen_string_literal: true
 
 require 'xapixctl/base_cli'
+require 'pathname'
 
 module Xapixctl
-  class Sync < BaseCli
-    option :org, aliases: "-o", desc: "Organization"
-    option :project, aliases: "-p", desc: "Project"
+  class SyncCli < BaseCli
+    class_option :credentials, desc: "Whether to include Credential resources in sync", type: :boolean, default: true
+    class_option :exclude_types, desc: "Resource types to exclude from sync", type: :array
+
     desc "to-dir DIRECTORY", "Syncs resources in project to directory"
     long_desc <<-LONGDESC
-      `xapixctl sync to-dir project dir` will export all resources of a given project and remove any additional resources from the directory.
+      `xapixctl sync to-dir DIRECTORY` will export all resources of a given project and remove any additional resources from the directory.
+
+      With --no-credentials you can exclude all credentials from getting exported.
+
+      With --exclude-types you can specify any resource types besides Project you'd like to exclude.
+
+      When excluding types, the excluded types will be recorded in the sync directory in a file called .excluded_types, so that any future syncs will exclude those types.
 
       Examples:
-      \x5> $ xapixctl sync to-dir xapix/some-project ./project_dir
+      \x5> $ xapixctl sync to-dir ./project_dir -p xapix/some-project
+      \x5> $ xapixctl sync to-dir ./project_dir -p xapix/some-project --no-credentials
+      \x5> $ xapixctl sync to-dir ./project_dir -p xapix/some-project --exclude-types=ApiPublishing ApiPublishingRole Credential
     LONGDESC
     def to_dir(dir)
-      sync_path = Pathname.new(dir)
+      sync_path = SyncPath.new(dir, prj_connection.resource_types_for_export, excluded_types)
 
       res_details = prj_connection.project_resource
-      write_resource_to(res_details, sync_path, 'project')
-      sync_path.join('README.md').write(generate_readme(res_details))
+      sync_path.write_file(generate_readme(res_details), 'README.md')
+      sync_path.write_resource_yaml(res_details, 'project')
 
-      prj_connection.resource_types_for_export.each do |type|
-        res_path = sync_path.join(type.underscore)
-        new_files = []
+      sync_path.types_to_sync.each do |type|
+        res_path = sync_path.resource_path(type)
         prj_connection.resource_ids(type).each do |res_id|
           res_details = prj_connection.resource(type, res_id)
-          new_files << write_resource_to(res_details, res_path, res_id)
-        end
-        (res_path.glob('*.yaml') - new_files).each do |outdated_file|
-          outdated_file.delete
-          puts "removed #{outdated_file}"
+          res_path.write_resource_yaml(res_details, res_id)
         end
+        res_path.remove_outdated_resources
       end
+      sync_path.update_excluded_types_file
     end
 
-    option :org, aliases: "-o", desc: "Organization"
-    option :project, aliases: "-p", desc: "Project"
     desc "from-dir DIRECTORY", "Syncs resources in project from directory"
     long_desc <<-LONGDESC
       `xapixctl sync from-dir project dir` will import all resources into the given project from the directory and remove any additional resources which are not present in the directory.
 
+      With --no-credentials you can exclude all credentials from getting exported.
+
+      With --exclude-types you can specify any resource types besides Project you'd like to exclude.
+
       Examples:
-      \x5> $ xapixctl sync from-dir xapix/some-project ./project_dir
+      \x5> $ xapixctl sync from-dir ./project_dir -p xapix/some-project
+      \x5> $ xapixctl sync from-dir ./project_dir -p xapix/some-project --no-credentials
+      \x5> $ xapixctl sync from-dir ./project_dir -p xapix/some-project --exclude-types=ApiPublishing ApiPublishingRole Credential
     LONGDESC
     def from_dir(dir)
-      sync_path = Pathname.new(dir)
+      sync_path = SyncPath.new(dir, prj_connection.resource_types_for_export, excluded_types)
 
-      resources_from_file(sync_path.join('project.yaml'), ignore_missing: false) do |desc|
+      sync_path.load_resource('project') do |desc|
         puts "applying #{desc['kind']} #{desc.dig('metadata', 'id')} to #{prj_connection.project}"
         desc['metadata']['id'] = prj_connection.project
         prj_connection.organization.apply(desc)
       end
 
       outdated_resources = {}
-      prj_connection.resource_types_for_export.each do |type|
-        res_path = sync_path.join(type.underscore)
+      sync_path.types_to_sync.each do |type|
+        res_path = sync_path.resource_path(type)
         updated_resource_ids = []
-        resources_from_file(res_path, ignore_missing: true) do |desc|
+        res_path.load_resources do |desc|
           puts "applying #{desc['kind']} #{desc.dig('metadata', 'id')}"
           updated_resource_ids += prj_connection.apply(desc)
         end
@@ -73,16 +84,74 @@ module Xapixctl
 
     private
 
-    def write_resource_to(res_details, res_path, res_name)
-      res_path.mkpath
-      unless res_path.directory? && res_path.writable?
-        warn "Cannot write to #{dir}, please check directory exists and is writable"
-        exit 1
+    class ResourcePath
+      def initialize(path)
+        @path = path
+        @resource_files = []
       end
-      res_file = res_path.join("#{res_name}.yaml")
-      res_file.write(res_details.to_yaml)
-      puts "updated #{res_file}..."
-      res_file
+
+      def write_file(content, filename)
+        @path.mkpath
+        unless @path.directory? && @path.writable?
+          warn "Cannot write to #{@path}, please check directory exists and is writable"
+          exit 1
+        end
+        file = @path.join(filename)
+        file.write(content)
+        puts "updated #{file}..."
+        file
+      end
+
+      def write_resource_yaml(res_details, res_name)
+        file = write_file(res_details.to_yaml, "#{res_name}.yaml")
+        @resource_files << file
+        file
+      end
+
+      def load_resources(&block)
+        Util.resources_from_file(@path, ignore_missing: true, &block)
+      end
+
+      def load_resource(res_name, &block)
+        Util.resources_from_file(@path.join("#{res_name}.yaml"), ignore_missing: false, &block)
+      end
+
+      def remove_outdated_resources
+        (@path.glob('*.yaml') - @resource_files).each do |outdated_file|
+          outdated_file.delete
+          puts "removed #{outdated_file}"
+        end
+      end
+    end
+
+    class SyncPath < ResourcePath
+      attr_reader :types_to_sync
+
+      def initialize(dir, all_types, excluded_types)
+        super(Pathname.new(dir))
+        @all_types = all_types
+        @excluded_types_file = @path.join('.excluded_types')
+        @excluded_types = excluded_types || []
+        @excluded_types += @excluded_types_file.read.split if @excluded_types_file.exist?
+        @excluded_types &= @all_types
+        @excluded_types.sort!
+        @types_to_sync = @all_types - @excluded_types
+        puts "Resource types excluded from sync: #{@excluded_types.join(', ')}" if @excluded_types.any?
+      end
+
+      def resource_path(type)
+        ResourcePath.new(@path.join(type.underscore))
+      end
+
+      def update_excluded_types_file
+        @excluded_types_file.write(@excluded_types.join(" ") + "\n") if @excluded_types.any?
+      end
+    end
+
+    def excluded_types
+      excluded = options[:exclude_types]
+      excluded += ['Credential'] unless options[:credentials]
+      excluded
     end
 
     def generate_readme(res_details)

data/lib/xapixctl/util.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Xapixctl
+  module Util
+    extend self
+
+    class InvalidDocumentStructureError < StandardError
+      def initialize(file)
+        super("#{file} has invalid document structure")
+      end
+    end
+
+    DOCUMENT_STRUCTURE = %w[version kind metadata definition].freeze
+
+    def resources_from_file(filename, ignore_missing: false)
+      load_files(filename, ignore_missing) do |actual_file, yaml_string|
+        yaml_string.split(/^---\s*\n/).map { |yml| Psych.safe_load(yml) }.compact.each do |doc|
+          raise InvalidDocumentStructureError, actual_file unless (DOCUMENT_STRUCTURE - doc.keys.map(&:to_s)).empty?
+          yield doc
+        end
+      end
+    end
+
+    def load_files(filename, ignore_missing)
+      if filename == '-'
+        yield 'STDIN', $stdin.read
+      else
+        pn = filename.is_a?(Pathname) ? filename : Pathname.new(filename)
+        if pn.directory?
+          pn.glob(["**/*.yaml", "**/*.yml"]).sort.each { |dpn| yield dpn.to_s, dpn.read }
+        elsif pn.exist?
+          yield pn.to_s, pn.read
+        elsif !ignore_missing
+          warn "file not found: #{filename}"
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/xapixctl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Xapixctl
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/xapixctl.gemspec

@@ -35,9 +35,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.1.4"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "relaxed-rubocop", "~> 2.5"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 1.11"
-  spec.add_development_dependency "rubocop-rake"
-  spec.add_development_dependency "rubocop-rspec"
-  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "rspec", "~> 3.10.0"
+  spec.add_development_dependency "rubocop", "~> 1.11.0"
+  spec.add_development_dependency "rubocop-rake", "~> 0.5.1"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.2.0"
+  spec.add_development_dependency "webmock", "~> 3.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xapixctl
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Michael Reinsch
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -118,70 +118,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.11.0
 description:
 email:
 - michael@xapix.io
@@ -213,6 +213,7 @@ files:
 - lib/xapixctl/phoenix_client/result_handler.rb
 - lib/xapixctl/preview_cli.rb
 - lib/xapixctl/sync_cli.rb
+- lib/xapixctl/util.rb
 - lib/xapixctl/version.rb
 - xapixctl.gemspec
 homepage: https://github.com/xapix-io/xapixctl