kong_schema 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ccf080d9311fc62088bf690a8d86af06fae4a97
-  data.tar.gz: fcba834c6e444a18c805e08487504a42186abe67
+  metadata.gz: 413c7b7271ed7feca20d06caeaf0bd671bf5d253
+  data.tar.gz: b79a0818ae360b7df3e7e9dc6a3ffc84398d3e05
 SHA512:
-  metadata.gz: 932e679e8c807a03e75e73ebdfe510a4374442ba6fcec7b43c7312532ef38d189c14005ad26cdbc7f2222faf12f75e21d53543ab3700e125f67dbeb8bd7270e3
-  data.tar.gz: dc34b51e197f958ab0708cd5a1bc6be8607fa7769780324a5f7b4e7f6ce5724da45593cfcd3e645d185e6f379a9ee2dcc52135f8e7c38bf5f04dc46c46790704
+  metadata.gz: fab914455b8b170f43ff70537e9604ac8e4489b6264356277257ddaff95f6df25c8cc36cae2107b5fd60987cb9a9bb4455e06319c97e67ea8824a35ce567b194
+  data.tar.gz: e1861af086a278bd9257469dccc314cc26211814bac1db35d8800171ad480a234b539c4424e25c40ac86ca13b081171577882c47f42dedee5c236ec091992726

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.2.0
+
+- Added a new CLI command: `kong_schema reset` for wiping out the Kong database
+  (still through its API)
+
 ## 1.1.1
 
 - Fixed an issue assigning the "methods" attribute of Kong::Api objects

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kong_schema (1.1.0)
+    kong_schema (1.2.0)
       diffy (~> 3.1)
       gli (~> 2.16)
       kong (~> 0.3)
@@ -12,7 +12,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
-    diffy (3.1.0)
+    diffy (3.2.0)
     docile (1.1.5)
     equatable (0.5.0)
     excon (0.49.0)

data/README.md

@@ -29,9 +29,22 @@ end
 ## Usage
 
 Write your desired configuration for Kong in a file using either YAML or JSON.
-The supported "directives" are described later in this document.
+The supported "directives" are described later in this document. Then you can
+use the `kong_schema` binary to perform various actions.
 
-For now we'll assume we have such a config file:
+Run `kong_schema --help` to see the available commands.
+
+```shell
+# apply configuration
+kong_schema up [path/to/config.yml]
+
+# reset configuration
+kong_schema reset [path/to/config.yml]
+```
+
+## Example
+
+Let's assume we have such a config file:
 
 ```yaml
 # file: config/kong.yml
@@ -41,12 +54,12 @@ kong:
     - name: application-api
       hosts:
         - api.application.dev
+      preserve_host: true
+      strip_uri: false
       upstream_url: http://application-api-lb
       uris:
         - /api/.+
         - /auth/.+
-      preserve_host: true
-      strip_uri: false
   upstreams:
     - name: application-api-lb
   targets:
@@ -57,7 +70,7 @@ kong:
 Then if we run the following command:
 
 ```shell
-bundle exec kong_schema up config/kong.yml
+kong_schema up config/kong.yml
 ```
 
 kong_schema will read the directives found under the `kong` dictionary and
@@ -155,9 +168,11 @@ Nice and easy!
 
 - name: String
 - host: String
+- methods: Array<String>
+- preserve_host: Boolean
+- strip_uri: Boolean
 - upstream_url: String
 - uris: Array<String>
-- preserve_host: Boolean
 
 ### `upstreams: Array<Kong::Upstream>`
 
@@ -165,8 +180,8 @@ Nice and easy!
 configuration:
 
 - name: String
-- ?slots: Number
-- ?orderlist: Array<Number>
+- slots: Number
+- orderlist: Array<Number>
 
 ### `targets: Array<Kong::Target>`
 
@@ -175,7 +190,7 @@ configuration:
 
 - upstream_id: String
 - target: String
-- ?weight: Number
+- weight: Number
 
 ## TODO
 

data/lib/kong_schema/cli.rb

@@ -14,9 +14,10 @@ module KongSchema
 
       version KongSchema::VERSION
 
+      sort_help :manually
+
       desc 'Apply configuration from a .yml or .json file.'
       arg(:config_file)
-
       command :up do |c|
         c.flag([ 'k', 'key' ], {
           default_value: 'kong',
@@ -38,12 +39,33 @@ module KongSchema
         })
 
         c.action do |global_options, options, args|
-          help_now! "Missing path to .yml or .json config file" if args.first.nil?
+          bail! "Missing path to .yml or .json config file" if args.first.nil?
 
           up(filepath: args.first, options: options)
         end
       end
 
+      desc 'Reset Kong configuration completely.'
+      arg(:config_file)
+      command :reset do |c|
+        c.flag([ 'k', 'key' ], {
+          default_value: 'kong',
+          desc: 'The root configuration property key.',
+          arg_name: 'NAME'
+        })
+
+        c.switch([ 'confirm' ], {
+          default_value: true,
+          desc: 'Prompt for confirmation before applying changes.'
+        })
+
+        c.action do |global_options, options, args|
+          bail! "Missing path to .yml or .json config file" if args.first.nil?
+
+          reset(filepath: args.first, options: options)
+        end
+      end
+
       super(argv)
     end
 
@@ -56,19 +78,31 @@ module KongSchema
 
       schema.scan(config).tap do |changes|
         if changes.empty?
-          puts "#{pastel.green('✓')} Nothing to update."
+          puts "#{green('✓')} Nothing to update."
         else
           puts KongSchema::Reporter.report(changes, object_format: options[:format].to_sym)
 
-          if TTY::Prompt.new.yes?('Commit the changes to Kong?', default: false)
+          if !options[:confirm] || yes?('Commit the changes to Kong?')
             schema.commit(config, changes)
 
-            puts "#{pastel.green('✓')} Kong has been reconfigured!"
+            puts "#{green('✓')} Kong has been reconfigured!"
           end
         end
       end
     end
 
+    def reset(filepath:, options:)
+      pastel = Pastel.new
+      schema = KongSchema::Schema
+      config = read_property(load_file(filepath), options[:key])
+
+      if !options[:confirm] || yes?("You are about to completely reset Kong's database. Proceed?")
+        KongSchema::Client.purge(config)
+
+        puts "#{green('✓')} Kong reset."
+      end
+    end
+
     def load_file(filepath)
       if filepath.end_with?('.json')
         JSON.parse(File.read(filepath))
@@ -84,5 +118,25 @@ module KongSchema
         config.fetch(key.to_s)
       end
     end
+
+    def yes?(message, default: false)
+      TTY::Prompt.new.yes?(message, default: default)
+    end
+
+    def red(text)
+      pastel.red(text)
+    end
+
+    def green(text)
+      pastel.green(text)
+    end
+
+    def pastel
+      @pastel ||= Pastel.new
+    end
+
+    def bail!(reason)
+      help_now! red("✘ #{reason}")
+    end
   end
 end

data/lib/kong_schema/client.rb

@@ -26,5 +26,17 @@ module KongSchema
     ensure
       Kong::Client.api_url = api_url
     end
+
+    # Reset Kong's database by removing all objects through the API.
+    def self.purge(config)
+      connect(config) do
+        KongSchema::Resource::Upstream.all.each do |upstream|
+          upstream.targets.each(&:delete)
+          upstream.delete
+        end
+
+        KongSchema::Resource::Api.all.each(&:delete)
+      end
+    end
   end
 end

data/lib/kong_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KongSchema
-  VERSION = "1.1.1".freeze
+  VERSION = "1.2.0".freeze
 end

data/spec/support/kong_schema_test_utils.rb

@@ -12,13 +12,6 @@ class KongSchemaTestUtils
   end
 
   def reset_kong
-    KongSchema::Client.connect(generate_config) do
-      KongSchema::Resource::Upstream.all.each do |upstream|
-        upstream.targets.each(&:delete)
-        upstream.delete
-      end
-
-      KongSchema::Resource::Api.all.each(&:delete)
-    end
+    KongSchema::Client.purge(generate_config)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kong_schema
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Ahmad Amireh