fakeit 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46f41bf28d7b4e0775fe84baa2d134947daa0e1ab114c4ad92bc95f63dc678be
-  data.tar.gz: ba497fcaf61e251e0316f7ac86223d84550f0c74d35db9319d3b152061de557b
+  metadata.gz: 9828311f1d6fb26ae16bf4bf4ec2fc5c52f5f88bfcdfc3df9ff4b9192671bf06
+  data.tar.gz: 6c739c443ae6506a9584ae8f41f37db3821ef7fc8533321bfdb762ef5d29a0ed
 SHA512:
-  metadata.gz: b7579ea64592fb2106a6a4af5d747f49be9eca739410a0decc0efb97fab22813a59cf416b57f13cfbc3ae0487449e7e1a5350533c98581baaa078d2266e80689
-  data.tar.gz: 42f1b09134e6f67cd933df04c00f9a154888830f500fd4d78a68bef780721d8f70f0409ee1a4d756640f5505783b2539d5856759f9096ff844fba5a023fdc843
+  metadata.gz: af522acb4552e1f45a6595a55aa1159ecf875813ac5547580fee0bd1a9962dfec73e58cc7f02cb53a0398b296537aca72f1cd733d2fbf0241994e9caf391e549
+  data.tar.gz: 9d0ddac0516f7019bb8459172f72570aa2d670d3aca019ac31deec62b165246438b1c0df3f1305a5ab6c9dd28344d195bf389a86b54150db00e3b5d14e90d058

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fakeit (0.2.1)
+    fakeit (0.3.0)
       faker (~> 1.9)
       openapi_parser (= 0.3.1)
       rack (~> 2.0)
@@ -31,7 +31,7 @@ GEM
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
-    rake (12.3.2)
+    rake (12.3.3)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -45,7 +45,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
-    rubocop (0.72.0)
+    rubocop (0.74.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)

data/README.md

@@ -9,6 +9,25 @@
 
 Create mock server from Openapi specification
 
+## Motivation
+
+Openapi mock server is one of core components to support contract based development and testing. As part of our journal, several key requirements for such mock server have been identified:
+
+* Control response generation in non intrusive manner. i.e. without modifying example in contract
+* Randomly generated response to support property based testing
+* Fulfill property reference in response generation to support development against contract. i.e. regarding the following response, guarantee the `selectedId` property is always a valid `id` in the items
+```json
+{
+  "selectedId": 1,
+  "items": [
+    { "id": 1 },
+    { "id": 2 }
+  ]
+}
+```
+
+After tried several existing options, we cannot find a best solution to meet all the requirements. So we decide to __'Fakeit till you make it'__.
+
 ## Features
 
 * Randomly or statically generated response
@@ -34,14 +53,14 @@ Command line options:
 
     $ fakeit --help
     usage:
-        --spec         spec file uri (required)
-        -p, --port     custom port
-        -q, --quiet    mute request and response log
-        --permissive   log validation error as warning instead of denying request
-        --use-example  use example provided in spec if exists
-
-    trial options:
-        --static       generate static response
+        --spec               spec file uri (required)
+        -p, --port           custom port
+        -q, --quiet          mute request and response log
+        --permissive         log validation error as warning instead of denying request
+        --use-example        use example provided in spec if exists
+        --static             generate static response
+        --static-types       generate static value for specified types, e.g. --static-types integer,string
+        --static-properties  generate static value for specified properties, e.g. --static-types id,uuid
 
     other options:
         -v, --version

data/bin/fakeit

@@ -12,9 +12,9 @@ begin
     o.bool '-q', '--quiet', 'mute request and response log'
     o.bool '--permissive', 'log validation error as warning instead of denying request'
     o.bool '--use-example', 'use example provided in spec if exists'
-    o.separator ''
-    o.separator 'trial options:'
     o.bool '--static', 'generate static response'
+    o.array '--static-types', 'generate static value for specified types, e.g. --static-types integer,string'
+    o.array '--static-properties', 'generate static value for specified properties, e.g. --static-types id,uuid'
     o.separator ''
     o.separator 'other options:'
     o.on '-v', '--version' do
@@ -47,7 +47,9 @@ end
 options = Fakeit::App::Options.new(
   permissive: opts.permissive?,
   use_example: opts.use_example?,
-  static: opts.static?
+  static: opts.static?,
+  static_types: opts[:static_types],
+  static_properties: opts[:static_properties]
 )
 app = Fakeit.build(opts[:spec], options)
 

data/docs/random.md

@@ -21,11 +21,13 @@ The following Openapi properties are supported in random response generation
 | |minLength|Default: `0`|
 | |maxLength|Default: `minLength + 10`|
 |integer|enum| |
-| |minimum|Default: `-2^31`|
-| |maximum|Default: `2^31 - 1`|
+| |minimum|Default: based on format|
+| |maximum|Default: based on format|
 | |exclusiveMinimum| |
 | |exclusiveMaximum| |
 | |multipleOf| |
+| |format=int32|`-2^31` ~ `2^31 - 1`|
+| |format=int64|`-2^63` ~ `2^63 - 1`|
 |number|minimum|Default: `-2^31`|
 | |maximum|Default: `2^31 - 1`|
 | |multipleOf| |

data/docs/static.md

@@ -24,6 +24,8 @@ Static value generation rule
 | |maximum|maximum|
 | |exclusiveMaximum|maximum - 1|
 | |multipleOf|maximum value meets multipleOf condition|
+| |format=int32|`2^31 - 1`|
+| |format=int64|`2^63 - 1`|
 |number|N/A|`2^31 - 1`|
 | |maximum|maximum rounded to 2 decimal places|
 | |multipleOf|maximum value meets multipleOf condition|

data/lib/fakeit/app/options.rb

@@ -1,12 +1,18 @@
 module Fakeit
   module App
     class Options
-      attr_reader :permissive, :use_example, :static
+      attr_reader :permissive, :use_example
 
-      def initialize(permissive: false, use_example: false, static: false)
+      def initialize(permissive: false, use_example: false, static: false, static_types: [], static_properties: [])
         @permissive = permissive
         @use_example = use_example
         @static = static
+        @static_types = static_types
+        @static_properties = static_properties
+      end
+
+      def use_static?(type: nil, property: nil)
+        @static || @static_types.include?(type) || @static_properties.include?(property)
       end
     end
   end

data/lib/fakeit/openapi/example/array_example.rb

@@ -3,7 +3,11 @@ module Fakeit
     module Example
       def array_example(options)
         example_options = add_depth(options)
-        example_options[:static] ? static_array_example(example_options) : random_array_example(example_options)
+        if example_options[:use_static][type: 'array', property: example_options[:property]]
+          static_array_example(example_options)
+        else
+          random_array_example(example_options)
+        end
       end
 
       private

data/lib/fakeit/openapi/example/boolean_example.rb

@@ -2,7 +2,7 @@ module Fakeit
   module Openapi
     module Example
       def boolean_example(example_options)
-        example_options[:static] || Faker::Boolean.boolean
+        example_options[:use_static][type: 'boolean', property: example_options[:property]] || Faker::Boolean.boolean
       end
     end
   end

data/lib/fakeit/openapi/example/integer_example.rb

@@ -2,7 +2,11 @@ module Fakeit
   module Openapi
     module Example
       def integer_example(example_options)
-        example_options[:static] ? static_integer_example : random_integer_example
+        if example_options[:use_static][type: 'integer', property: example_options[:property]]
+          static_integer_example
+        else
+          random_integer_example
+        end
       end
 
       private

data/lib/fakeit/openapi/example/number_example.rb

@@ -5,7 +5,11 @@ module Fakeit
       MAX_NUM = 2**31 - 1
 
       def number_example(example_options)
-        example_options[:static] ? static_number_example : random_number_example
+        if example_options[:use_static][type: 'number', property: example_options[:property]]
+          static_number_example
+        else
+          random_number_example
+        end
       end
 
       private

data/lib/fakeit/openapi/example/object_example.rb

@@ -2,7 +2,9 @@ module Fakeit
   module Openapi
     module Example
       def object_example(example_options)
-        properties.each_with_object({}) { |(name, schema), obj| obj[name] = schema.to_example(example_options) }
+        properties.each_with_object({}) do |(name, schema), obj|
+          obj[name] = schema.to_example(example_options.merge(property: name))
+        end
       end
     end
   end

data/lib/fakeit/openapi/example/string_example.rb

@@ -23,22 +23,33 @@ module Fakeit
       }.freeze
 
       def string_example(example_options)
-        example_options[:static] ? static_string_example : random_string_example
+        if example_options[:use_static][type: 'string', property: example_options[:property]]
+          static_string_example
+        else
+          random_string_example
+        end
       end
 
       private
 
       def static_string_example
-        Faker::Config.random = Random.new(1) # Fix seed for faker
-
-        if enum then enum.to_a.first
-        elsif pattern then Faker::Base.regexify(pattern)
-        elsif format then static_string_format
-        elsif length_constraint then static_string_with_length
-        else 'string'
+        fixed_faker do
+          if enum then enum.to_a.first
+          elsif pattern then Faker::Base.regexify(pattern)
+          elsif format then static_string_format
+          elsif length_constraint then static_string_with_length
+          else 'string'
+          end
         end
       end
 
+      def fixed_faker(&block)
+        Faker::Config.random = Random.new(1)
+        result = block.call
+        Faker::Config.random = nil
+        result
+      end
+
       def random_string_example
         if enum then enum.to_a.sample
         elsif pattern then Faker::Base.regexify(pattern)

data/lib/fakeit/openapi/loader.rb

@@ -14,9 +14,9 @@ module Fakeit
 
       def parse_method(src)
         case File.extname(src)
-        when '.json' then
+        when '.json'
           JSON.method(:parse)
-        when '.yml', '.yaml' then
+        when '.yml', '.yaml'
           YAML.method(:safe_load)
         else
           raise 'Invalid openapi specification file'

data/lib/fakeit/openapi/operation.rb

@@ -33,7 +33,7 @@ module Fakeit
       private
 
       def example_options
-        { use_example: @app_options.use_example, static: @app_options.static, depth: 0 }
+        { use_example: @app_options.use_example, use_static: @app_options.method(:use_static?), depth: 0 }
       end
 
       def response_content

data/lib/fakeit/openapi/schema.rb

@@ -23,7 +23,11 @@ module Fakeit
       private
 
       def one_of_example(example_options)
-        example_options[:static] ? one_of.first.to_example(example_options) : one_of.sample.to_example(example_options)
+        if example_options[:use_static][property: example_options[:property]]
+          one_of.first.to_example(example_options)
+        else
+          one_of.sample.to_example(example_options)
+        end
       end
 
       def all_of_example(example_options)
@@ -34,13 +38,23 @@ module Fakeit
       end
 
       def any_of_example(example_options)
-        any_of
-          .select { |option| option.type == 'object' }
-          .then { |options| example_options[:static] ? options : options.sample(Faker::Number.between(1, any_of.size)) }
+        any_of_options(example_options)
           .map { |option| option.to_example(example_options) }
           .reduce(&:merge)
       end
 
+      def any_of_options(example_options)
+        any_of
+          .select { |option| option.type == 'object' }
+          .then do |options|
+            if example_options[:use_static][property: example_options[:property]]
+              options
+            else
+              options.sample(Faker::Number.between(1, any_of.size))
+            end
+          end
+      end
+
       def type_based_example(example_options)
         send("#{type}_example", example_options) if %w[string integer number boolean array object].include?(type)
       end

data/lib/fakeit/version.rb

@@ -1,3 +1,3 @@
 module Fakeit
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fakeit
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Justin Feng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-04 00:00:00.000000000 Z
+date: 2019-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler