kumonos 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 981d08ab41459f0b6974d1e9db66bf36298319cd
-  data.tar.gz: a8f4fbb16ebb30de0b587a5820a37beb1d6e4da6
+  metadata.gz: 4c5bcbbfe1bf50df5f3ca86866224f841ff22215
+  data.tar.gz: bd670f7af51eec530a2b038bcd6308d32d93dbbf
 SHA512:
-  metadata.gz: ecec920e45a4165cb2774c3e8b8b5d21990da3da8b0077ae8f18c0158800623faa95570d7f610dc54510444b192c8a93096516bf15ec58da482223a26b4c1496
-  data.tar.gz: 4ef6d9a17b3ee7fc7b1307cf0d5b11a2092b7ee75a4468629e6683e4f0ccec664bba8b6b8f3c8bc391a298f9ddbcf705ef1a758de37eb2e615927685dfae9d7f
+  metadata.gz: 38dc408e5f62ef628f557d604c7c2d2f41225b7e4155bce923e4dd5ab534205913f714a12f234d5630ee5f4a54789c66c69587119adef7cb6bd9db85b391a7ca
+  data.tar.gz: b310762a15b754e011d4e1aa8b8c95a9cfb4c0745ce471573fa339ae6ae745c78d6a3660973509229bb6cc6a81754ae29c8c7e4d6c3b0a3df9ad69d12e33f1b1

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   DisplayCopNames: true
+  DisplayStyleGuide: true
 
 Metrics/BlockLength:
   Enabled: false

data/Rakefile

@@ -1,6 +1,19 @@
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
 
+require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+desc 'Run integration test'
+task :integration_test do
+  Dir.chdir('test') do
+    sh './run_test'
+  end
+end
+
+desc 'Run all tests'
+task all: %i[spec rubocop integration_test]

data/{bump.rb → bump}

@@ -1,6 +1,7 @@
+#!/usr/bin/env ruby
 level = ARGV.first
 if level.nil?
-  warn "Example: ruby #{__FILE__} (tiny|minor|major)"
+  warn "Example: #{__FILE__} (tiny|minor|major)"
   exit 1
 end
 
@@ -25,7 +26,7 @@ when 'major'
   version_strs[1] = 0
   version_strs[2] = 0
 else
-  warn "Example: ruby #{__FILE__} (tiny|minor|major)"
+  warn "Example: #{__FILE__} (tiny|minor|major)"
   exit 1
 end
 

data/example/book.yml

@@ -1,7 +1,7 @@
 # A definition for book service.
 # The book service uses user service and ab-testing service.
 version: 1
-services:
+dependencies:
   - name: 'user'
     lb: 'user:8080'
     connect_timeout_ms: 250
@@ -15,7 +15,7 @@ services:
         retry_policy:
           retry_on: '5xx,connect-failure,refused-stream'
           num_retries: 3
-          per_try_timeout_ms: 250
+          per_try_timeout_ms: 1000
   - name: 'ab-testing'
     lb: 'ab-testing:8080'
     connect_timeout_ms: 250
@@ -29,4 +29,4 @@ services:
         retry_policy:
           retry_on: '5xx,connect-failure,refused-stream'
           num_retries: 3
-          per_try_timeout_ms: 250
+          per_try_timeout_ms: 1000

data/exe/kumonos

@@ -29,6 +29,7 @@ class KumonosCli < Thor
   def clusters(filepath, output_dir)
     name = File.basename(filepath, '.*')
     definition = YAML.load_file(filepath)
+    validate_service_definition!(definition, filepath)
     out = JSON.dump(Kumonos.generate_clusters(definition))
 
     output_dir = Pathname.new(output_dir)
@@ -42,6 +43,7 @@ class KumonosCli < Thor
   def routes(filepath, output_dir)
     name = File.basename(filepath, '.*')
     definition = YAML.load_file(filepath)
+    validate_service_definition!(definition, filepath)
     out = JSON.dump(Kumonos.generate_routes(definition))
 
     output_dir = Pathname.new(output_dir)
@@ -50,6 +52,30 @@ class KumonosCli < Thor
     target.write(out)
     puts target
   end
+
+  desc 'init NAME', 'Generate a service definition'
+  def init(name)
+    definition = YAML.load_file(File.expand_path('../example/book.yml', __dir__))
+    definition['dependencies'] = definition.fetch('dependencies')[0..0]
+    dep = definition['dependencies'][0]
+    dep['name'] = 'target-service-name'
+    dep['lb'] = 'hostname-for-load-balancer:port'
+    path = "#{name}.yml"
+    File.open(path, 'w') { |f| YAML.dump(definition, f) }
+    puts path
+  end
+
+  private
+
+  def validate_service_definition!(definition, filepath)
+    result = Kumonos::Schemas.validate_service_definition(definition)
+    return if result.empty?
+
+    warn("#{filepath} has invalid format:")
+    warn(result)
+    warn("A schema file is #{Kumonos::Schemas::SERVIVE_DEFINITION_PATH}")
+    exit 1
+  end
 end
 
 KumonosCli.start(ARGV)

data/lib/kumonos/schemas.rb

@@ -6,6 +6,7 @@ module Kumonos
   module Schemas
     ROOT = Pathname.new(File.expand_path('../schemas', __dir__))
     CONFIG_SCHEMA_PATH = ROOT.join('kumonos_config.json')
+    SERVIVE_DEFINITION_PATH = ROOT.join('service_definition.json')
 
     class << self
       def validate_kumonos_config(hash)
@@ -13,6 +14,11 @@ module Kumonos
         JSON::Validator.fully_validate(schema, hash)
       end
 
+      def validate_service_definition(hash)
+        schema = load_schema(SERVIVE_DEFINITION_PATH)
+        JSON::Validator.fully_validate(schema, hash)
+      end
+
       private
 
       def load_schema(path)

data/lib/kumonos/version.rb

@@ -1,3 +1,3 @@
 module Kumonos
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/kumonos.rb

@@ -46,16 +46,15 @@ module Kumonos
     end
 
     def generate_routes(definition)
-      virtual_hosts = definition['services'].map { |s| service_to_vhost(s) }
       {
         validate_clusters: false,
-        virtual_hosts: virtual_hosts
+        virtual_hosts: definition['dependencies'].map { |s| service_to_vhost(s) }
       }
     end
 
     def generate_clusters(definition)
       {
-        clusters: definition['services'].map { |s| service_to_cluster(s) }
+        clusters: definition['dependencies'].map { |s| service_to_cluster(s) }
       }
     end
 
@@ -63,7 +62,6 @@ module Kumonos
 
     def service_to_vhost(service)
       name = service['name']
-
       {
         name: name,
         domains: [name],

data/lib/schemas/service_definition.json

@@ -0,0 +1,131 @@
+{
+  "definitions": {},
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "id": "service-definition",
+  "additionalProperties": false,
+  "required": [
+    "version",
+    "dependencies"
+  ],
+  "properties": {
+    "version": {
+      "type": "integer",
+      "id": "/properties/version",
+      "default": 1
+    },
+    "dependencies": {
+      "type": "array",
+      "id": "/properties/dependencies",
+      "items": {
+        "type": "object",
+        "id": "/properties/dependencies/items",
+        "additionalProperties": false,
+        "required": [
+          "name",
+          "lb",
+          "connect_timeout_ms",
+          "circuit_breaker",
+          "routes"
+        ],
+        "properties": {
+          "name": {
+            "type": "string",
+            "id": "/properties/dependencies/items/properties/name",
+            "default": "dependency-service-name"
+          },
+          "lb": {
+            "type": "string",
+            "id": "/properties/dependencies/items/properties/lb",
+            "default": "host:port"
+          },
+          "connect_timeout_ms": {
+            "type": "integer",
+            "id": "/properties/dependencies/items/properties/connect_timeout_ms",
+            "default": 250
+          },
+          "circuit_breaker": {
+            "type": "object",
+            "id": "/properties/dependencies/items/properties/circuit_breaker",
+            "additionalProperties": false,
+            "required": [
+              "max_connections",
+              "max_pending_requests",
+              "max_retries"
+            ],
+            "properties": {
+              "max_connections": {
+                "type": "integer",
+                "id": "/properties/dependencies/items/properties/circuit_breaker/properties/max_connections",
+                "default": 64
+              },
+              "max_pending_requests": {
+                "type": "integer",
+                "id": "/properties/dependencies/items/properties/circuit_breaker/properties/max_pending_requests",
+                "default": 128
+              },
+              "max_retries": {
+                "type": "integer",
+                "id": "/properties/dependencies/items/properties/circuit_breaker/properties/max_retries",
+                "default": 3
+              }
+            }
+          },
+          "routes": {
+            "type": "array",
+            "id": "/properties/dependencies/items/properties/routes",
+            "items": {
+              "type": "object",
+              "id": "/properties/dependencies/items/properties/routes/items",
+              "additionalProperties": false,
+              "required": [
+                "prefix",
+                "timeout_ms",
+                "retry_policy"
+              ],
+              "properties": {
+                "prefix": {
+                  "type": "string",
+                  "id": "/properties/dependencies/items/properties/routes/items/properties/prefix",
+                  "default": "/"
+                },
+                "timeout_ms": {
+                  "type": "integer",
+                  "id": "/properties/dependencies/items/properties/routes/items/properties/timeout_ms",
+                  "default": 3000
+                },
+                "retry_policy": {
+                  "type": "object",
+                  "id": "/properties/dependencies/items/properties/routes/items/properties/retry_policy",
+                  "additionalProperties": false,
+                  "required": [
+                    "retry_on",
+                    "num_retries",
+                    "per_try_timeout_ms"
+                  ],
+                  "properties": {
+                    "retry_on": {
+                      "type": "string",
+                      "id": "/properties/dependencies/items/properties/routes/items/properties/retry_policy/properties/retry_on",
+                      "default": "5xx,connect-failure,refused-stream"
+                    },
+                    "num_retries": {
+                      "type": "integer",
+                      "id": "/properties/dependencies/items/properties/routes/items/properties/retry_policy/properties/num_retries",
+                      "default": 3
+                    },
+                    "per_try_timeout_ms": {
+                      "type": "integer",
+                      "id": "/properties/dependencies/items/properties/routes/items/properties/retry_policy/properties/per_try_timeout_ms",
+                      "default": 1000
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kumonos
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Taiki Ono
@@ -126,7 +126,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- bump.rb
+- bump
 - example/book.yml
 - example/kumonos.json
 - exe/kumonos
@@ -136,6 +136,7 @@ files:
 - lib/kumonos/schemas.rb
 - lib/kumonos/version.rb
 - lib/schemas/kumonos_config.json
+- lib/schemas/service_definition.json
 homepage: https://github.com/taiki45/kumonos
 licenses:
 - MIT