kong_schema 1.1.0

data/spec/kong_schema/resource/target_spec.rb

@@ -0,0 +1,209 @@
+describe KongSchema::Resource::Target do
+  let(:schema) { KongSchema::Schema }
+  let(:test_utils) { KongSchemaTestUtils.new }
+
+  after(:each) do
+    test_utils.reset_kong
+  end
+
+  describe 'creating targets' do
+    let :config do
+      test_utils.generate_config({
+        upstreams: [{
+          name: 'bridge-learn.kong-service'
+        }],
+
+        targets: [{
+          upstream_id: 'bridge-learn.kong-service',
+          target: '127.0.0.1:3000'
+        }]
+      })
+    end
+
+    it 'adds a target if it does not exist' do
+      directives = schema.scan(config)
+
+      expect(directives.map(&:class)).to eq([ KongSchema::Actions::Create, KongSchema::Actions::Create ])
+    end
+
+    it 'does add a target' do
+      directives = schema.scan(config)
+
+      expect {
+        schema.commit(config, directives)
+      }.to change {
+        KongSchema::Client.connect(config) { Kong::Upstream.all.count }
+      }.by(1)
+    end
+
+    it 'does not add a target if it exists' do
+      directives = schema.scan(config)
+
+      schema.commit(config, directives)
+
+      next_directives = schema.scan(config)
+
+      expect(next_directives.map(&:class)).not_to include(KongSchema::Actions::Create)
+    end
+
+    it 'does not allow defining a target without an upstream_id' do
+      directives = schema.scan(test_utils.generate_config({
+        targets: [{ target: '127.0.0.1:3000' }]
+      }))
+
+      expect {
+        schema.commit(config, directives)
+      }.to raise_error(/Can not add a target without an upstream!/)
+    end
+  end
+
+  describe "changing a target's target" do
+    let :config do
+      test_utils.generate_config({
+        upstreams: [{
+          name: 'bridge-learn.kong-service'
+        }],
+
+        targets: [{
+          upstream_id: 'bridge-learn.kong-service',
+          target: '127.0.0.1:3000'
+        }]
+      })
+    end
+
+    let :with_updated do
+      test_utils.generate_config({
+        upstreams: [{
+          name: 'bridge-learn.kong-service'
+        }],
+
+        targets: [{
+          upstream_id: 'bridge-learn.kong-service',
+          target: '127.0.0.1:9999'
+        }]
+      })
+    end
+
+    before(:each) do
+      schema.commit(config, schema.scan(config))
+    end
+
+    it 'identifies targets to be updated' do
+      directives = schema.scan(with_updated)
+
+      expect(directives.map(&:class)).to eq([KongSchema::Actions::Create, KongSchema::Actions::Delete])
+    end
+
+    it 'updates a target' do
+      expect {
+        schema.commit(with_updated, schema.scan(with_updated))
+      }.to change {
+        KongSchema::Client.connect(config) {
+          KongSchema::Resource::Target.all.map { |x| [ x.weight, x.target ] }
+        }
+      }.from([
+        [ 100, '127.0.0.1:3000' ]
+      ]).to([
+        [ 100,  '127.0.0.1:9999' ]
+      ])
+    end
+  end
+
+  describe "changing a target's weight" do
+    let :config do
+      test_utils.generate_config({
+        upstreams: [{
+          name: 'bridge-learn.kong-service'
+        }],
+
+        targets: [{
+          upstream_id: 'bridge-learn.kong-service',
+          target: '127.0.0.1:3000'
+        }]
+      })
+    end
+
+    let :with_different_weight do
+      test_utils.generate_config({
+        upstreams: [{
+          name: 'bridge-learn.kong-service'
+        }],
+
+        targets: [{
+          upstream_id: 'bridge-learn.kong-service',
+          target: '127.0.0.1:3000',
+          weight: 20
+        }]
+      })
+    end
+
+    before(:each) do
+      schema.commit(config, schema.scan(config))
+    end
+
+    it 'updates the existing target' do
+      directives = schema.scan(with_different_weight)
+
+      expect(directives.map(&:class)).to eq([ KongSchema::Actions::Update ])
+    end
+
+    it 'updates a target' do
+      expect {
+        schema.commit(with_different_weight, schema.scan(with_different_weight))
+      }.to change {
+        KongSchema::Client.connect(config) {
+          KongSchema::Resource::Target.all.map { |x| [ x.weight, x.target ] }
+        }
+      }.from([
+        [ 100, '127.0.0.1:3000' ]
+      ]).to([
+        [ 20,  '127.0.0.1:3000' ]
+      ])
+    end
+  end
+
+  describe 'deleting targets' do
+    let :config do
+      test_utils.generate_config(
+        upstreams: [{
+          name: 'bridge-learn.kong-service'
+        }],
+
+        targets: [{
+          upstream_id: 'bridge-learn.kong-service',
+          target: '127.0.0.1:3000'
+        }]
+      )
+    end
+
+    let :with_deleted do
+      test_utils.generate_config(
+        upstreams: [{ name: 'bridge-learn.kong-service' }],
+        targets: []
+      )
+    end
+
+    before(:each) do
+      schema.commit(config, schema.scan(config))
+    end
+
+    it 'identifies targets to be deleted' do
+      directives = schema.scan(with_deleted)
+
+      expect(directives.map(&:class)).to include(KongSchema::Actions::Delete)
+    end
+
+    it 'deletes a target' do
+      expect {
+        schema.commit(with_deleted, schema.scan(with_deleted))
+      }.to change {
+        KongSchema::Client.connect(config) {
+          KongSchema::Resource::Target.all.map { |x| [ x.target, x.weight ] }
+        }
+      }.from([
+        [ '127.0.0.1:3000', 100 ]
+      ]).to([
+      ])
+    end
+  end
+end

data/spec/kong_schema/resource/upstream_spec.rb

@@ -0,0 +1,122 @@
+describe KongSchema::Resource::Upstream do
+  let(:schema) { KongSchema::Schema }
+  let(:test_utils) { KongSchemaTestUtils.new }
+
+  after(:each) do
+    test_utils.reset_kong
+  end
+
+  describe 'creating upstreams' do
+    let :config do
+      test_utils.generate_config({
+        upstreams: [{
+          name: 'bridge-learn.kong-service'
+        }]
+      })
+    end
+
+    it 'adds an upstream if it does not exist' do
+      changes = schema.scan(config)
+
+      expect(changes.map(&:class)).to include(KongSchema::Actions::Create)
+    end
+
+    it 'does add an upstream' do
+      changes = schema.scan(config)
+
+      expect {
+        schema.commit(config, changes)
+      }.to change {
+        KongSchema::Client.connect(config) { Kong::Upstream.all.count }
+      }.by(1)
+    end
+
+    it 'does not add an upstream if it exists' do
+      changes = schema.scan(config)
+
+      schema.commit(config, changes)
+
+      next_changes = schema.scan(config)
+
+      expect(next_changes.map(&:class)).not_to include(KongSchema::Actions::Create)
+    end
+  end
+
+  describe 'updating upstreams' do
+    let :config do
+      test_utils.generate_config({
+        upstreams: [{
+          name: 'bridge-learn.kong-service',
+        }]
+      })
+    end
+
+    let :with_updated_config do
+      test_utils.generate_config({
+        upstreams: [{
+          name: 'bridge-learn.kong-service',
+          slots: 50,
+          orderlist: nil
+        }]
+      })
+    end
+
+    before(:each) do
+      schema.commit(config, schema.scan(config))
+    end
+
+    it 'updates an upstream' do
+      changes = schema.scan(with_updated_config)
+
+      expect(changes.map(&:class)).to eq([ KongSchema::Actions::Update ])
+    end
+
+    it 'does update an upstream' do
+      changes = schema.scan(with_updated_config)
+
+      expect {
+        schema.commit(with_updated_config, changes)
+      }.to change {
+        KongSchema::Client.connect(config) {
+          Kong::Upstream.all.first.slots
+        }
+      }.from(100).to(50)
+    end
+  end
+
+  describe 'deleting upstreams' do
+    let :config do
+      test_utils.generate_config({
+        upstreams: [{
+          name: 'bridge-learn.kong-service',
+        }]
+      })
+    end
+
+    let :with_deleted_config do
+      test_utils.generate_config({
+        upstreams: []
+      })
+    end
+
+    before(:each) do
+      schema.commit(config, schema.scan(config))
+    end
+
+    it 'deletes an upstream' do
+      changes = schema.scan(with_deleted_config)
+
+      expect(changes.map(&:class)).to include(KongSchema::Actions::Delete)
+    end
+
+    it 'does delete an upstream' do
+      changes = schema.scan(with_deleted_config)
+
+      expect {
+        schema.commit(with_deleted_config, changes)
+      }.to change {
+        KongSchema::Client.connect(config) { Kong::Upstream.all.count }
+      }.from(1).to(0)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,109 @@
+require_relative './support/coverage' if ENV["COVERAGE"] == "1"
+require_relative './support/kong_schema_test_utils'
+
+require 'kong_schema'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.before(:all) do
+    KongSchemaTestUtils.new.reset_kong
+  end
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+  config.filter_run_when_matching :focus
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/coverage.rb

@@ -0,0 +1,18 @@
+require "simplecov"
+require "simplecov_compact_json"
+
+SimpleCov.at_exit do
+  SimpleCov.minimum_coverage(95)
+  SimpleCov.maximum_coverage_drop(1)
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::CompactJSON,
+    SimpleCov::Formatter::HTMLFormatter
+  ]
+  SimpleCov.result.format!
+end
+
+SimpleCov.start do
+  add_filter "/.gem/"
+  add_filter "/bin/"
+  add_filter "/spec/"
+end

data/spec/support/kong_schema_test_utils.rb

@@ -0,0 +1,24 @@
+require 'kong_schema'
+
+class KongSchemaTestUtils
+  attr_reader :host
+
+  def initialize(host: ENV.fetch('KONG_URI', '127.0.0.1:9712'))
+    @host = host
+  end
+
+  def generate_config(config = {})
+    JSON.parse(JSON.dump({ admin_host: host }.merge(config)))
+  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
+  end
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: kong_schema
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Ahmad Amireh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: kong
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: simplecov_compact_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- ahmad@instructure.com
+executables:
+- kong_schema
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- bin/kong_schema
+- ext/kong/upstream.rb
+- kong_schema.gemspec
+- lib/kong_schema.rb
+- lib/kong_schema/actions.rb
+- lib/kong_schema/adapter.rb
+- lib/kong_schema/cli.rb
+- lib/kong_schema/client.rb
+- lib/kong_schema/reporter.rb
+- lib/kong_schema/resource.rb
+- lib/kong_schema/resource/api.rb
+- lib/kong_schema/resource/target.rb
+- lib/kong_schema/resource/upstream.rb
+- lib/kong_schema/schema.rb
+- lib/kong_schema/version.rb
+- spec/examples.txt
+- spec/kong_schema/reporter_spec.rb
+- spec/kong_schema/resource/api_spec.rb
+- spec/kong_schema/resource/target_spec.rb
+- spec/kong_schema/resource/upstream_spec.rb
+- spec/spec_helper.rb
+- spec/support/coverage.rb
+- spec/support/kong_schema_test_utils.rb
+homepage: https://github.com/amireh/kong_schema
+licenses:
+- AGPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Configure Kong from a file using its REST API.
+test_files:
+- spec/examples.txt
+- spec/kong_schema/reporter_spec.rb
+- spec/kong_schema/resource/api_spec.rb
+- spec/kong_schema/resource/target_spec.rb
+- spec/kong_schema/resource/upstream_spec.rb
+- spec/spec_helper.rb
+- spec/support/coverage.rb
+- spec/support/kong_schema_test_utils.rb
+has_rdoc: