jfuzz 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08353dd154630cdb6bf5f4707a318a517d6c8823d3aac68d873573e06be06a5a'
-  data.tar.gz: 621e2214e475cf5980fcc3230b112599a4898e042e0fbacb0c788ca0fc7c7b93
+  metadata.gz: cc0fdee0ca3b32ea585dbc281829c47c06d03e8f3206ce657efd4eafcf43aaa2
+  data.tar.gz: e2a9f85044898fa8e901813d57d089f16a47c1d453480b66d102cdc4caaef6d0
 SHA512:
-  metadata.gz: a2fbac9102de57fe22c2c92a4cde52de9c9b9733d5095ee3ec80c49552179a897e46fa356d62acc9c94e4c82b0cee24bc4c0458c463ca0d30a7f0cdb762306af
-  data.tar.gz: a81648f6dd527a930e7f77d14af2b6dd30b6e27b2bf14ded042b10aadb45379938bdf607143ff69c9e3b4fa7e5af3dd16fd5119df4bb72f12f0903b251b206ae
+  metadata.gz: ff61efb91b1756db9388a7d73eb68f38a971564508ff26b8f1e088c9e0098dde2ac060959a878c018532bb42e93094ba2b3467fc8000bb3ca44ebc8ae9599f70
+  data.tar.gz: b34b542836b14d6b211306218bad97298bb2ead2030bcbf23d0ebc8232f508204c0a1f8d34d1840c4fa17e1af8e3f80681ce9feede4f715c7ee5d8ebac9f8916

data/.rubocop.yml

@@ -119,3 +119,9 @@ RSpec/MessageSpies:
 
 RSpec/Pending:
   Enabled: true
+
+Metrics/MethodLength:
+  Max: 58
+
+Naming/AccessorMethodName:
+  Enabled: false

data/README.md

@@ -29,11 +29,66 @@ Jfuzz.fuzz(schema_path)
 
 ### Configuration
 
-TODO Describe how to change config
+#### Nil Probability
+
+This determines how often we leave out optional fields. The default is `0.2` meaning we will leave out optional fields 20% of the time. It can be changed by:
+
+```
+Jfuzz.set_nil_probability(0.5)
+```
+
+#### True Probability
+
+This determines how likely a boolean type is to have a true value. The default is `0.5`
+
+```
+Jfuzz.set_true_probability(0.5)
+```
+
+
+#### Min/Max Integer/Number values
+
+You can change the min and max values of integers/numbers that are used when no minimums or maximums are supplied in your schema. The defaults are: -9999999 and 9999999.
+
+```
+Jfuzz.set_min_integer(10)
+Jfuzz.set_max_integer(100)
+```
+
+#### Min/Max Array Lengths
+
+You can change the min and max length of arrays. These are used to generate a random length for an array when you do no specify a min or a max length in you schema. The defaults are 1 and 100
+
+```
+Jfuzz.set_min_array_length(10)
+Jfuzz.set_max_array_length(100)
+```
 
 ### Generators
 
-TODO Describe how to add/edit generators
+If you want custom behaviour when fuzzing a particular type, you can change our built in default generators. This is also useful if you want to add support for your own custom type. First you must define a generator class, e.g. lets say we want to do our own string generation logic:
+
+```ruby
+require "jfuzz/generators/generator"
+
+class BetterStringGenerator < Jfuzz::Generator
+    def generate
+        "AMAZING STRING"
+    end
+
+    def self.type
+      "string"
+    end
+end
+```
+
+Finally you need to register the generator with JFuzz by doing the following:
+
+```ruby
+Jfuzz.register_generator(BetterStringGenerator)
+```
+
+Note. You will need to register your new generator before calling `Jfuzz.fuzz`
 
 ## Development
 
@@ -43,7 +98,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jfuzz.
+Bug reports and pull requests are welcome on GitHub at https://github.com/georgea93/jfuzz.
 
 
 ## License

data/jfuzz.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport", "~> 5.2"
+  spec.add_dependency "activesupport", "~> 5.1"
   spec.add_dependency "json_schema", "~> 0.17"
   spec.add_dependency "regexp-examples", "~> 1.4"
 

data/lib/jfuzz.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'active_support/core_ext/module/delegation'
+require "active_support/core_ext/module/delegation"
 
 require "jfuzz/version"
 require "jfuzz/configuration"
@@ -13,14 +13,13 @@ require "jfuzz/generators/object_generator"
 require "jfuzz/generators/array_generator"
 require "jfuzz/generators/string_generator"
 
-
 module Jfuzz
   def self.configuration
     @configuration ||= Configuration.new
   end
 
   def self.fuzz(schema_path)
-   SchemaFuzzer.new(schema_path).fuzz
+    SchemaFuzzer.new(schema_path).fuzz
   end
 
   class << self
@@ -46,7 +45,7 @@ module Jfuzz
   def self.set_true_probability(val)
     configuration.true_probability = val
   end
-  
+
   def self.set_min_integer(val)
     configuration.min_integer = val
   end

data/lib/jfuzz/configuration.rb

@@ -11,7 +11,7 @@ module Jfuzz
       @min_integer = 0
       @max_integer = 0
       @min_array_length = 0
-      @max_array_length = 0 
+      @max_array_length = 0
     end
 
     attr_reader :generators

data/lib/jfuzz/generators/array_generator.rb

@@ -5,13 +5,9 @@ require "jfuzz/generators/generator"
 module Jfuzz
   class ArrayGenerator < Generator
     def generate
-      unless items.any?
-        raise "Cannot generate an empty array. Please specify item types"
-      end
+      raise "Cannot generate an empty array. Please specify item types" unless items.any?
 
-      if items.kind_of?(Array)
-        return tuple_array
-      end
+      return tuple_array if items.is_a?(Array)
       random_array
     end
 

data/lib/jfuzz/generators/boolean_generator.rb

@@ -5,9 +5,7 @@ require "jfuzz/generators/generator"
 module Jfuzz
   class BooleanGenerator < Generator
     def generate
-      if rand < Jfuzz.true_probability
-        return true
-      end
+      return true if rand < Jfuzz.true_probability
       false
     end
 

data/lib/jfuzz/generators/integer_generator.rb

@@ -8,7 +8,7 @@ module Jfuzz
     def generate
       random_integer
     end
-    
+
     def self.type
       "integer"
     end
@@ -18,12 +18,8 @@ module Jfuzz
     def random_integer
       min = minimum
       max = maximum
-      if exclusive_minimum?
-        min + 1
-      end
-      if exclusive_maximum?
-        max - 1
-      end
+      min + 1 if exclusive_minimum?
+      max - 1 if exclusive_maximum?
 
       return generate_multiple(min, max) if multiple_of?
 
@@ -33,22 +29,18 @@ module Jfuzz
     def generate_multiple(min, max)
       factor = property.fetch("multipleOf").to_i
 
-      min = min / factor
-      max = max / factor
+      min /= factor
+      max /= factor
       rand(min..max).to_i * factor
     end
 
     def minimum
-      if minimum?
-        return property.fetch("minimum").to_i
-      end
+      return property.fetch("minimum").to_i if minimum?
       Jfuzz.min_integer.to_i
     end
 
     def maximum
-      if maximum?
-        return property.fetch("maximum").to_i
-      end
+      return property.fetch("maximum").to_i if maximum?
       Jfuzz.max_integer.to_i
     end
 

data/lib/jfuzz/generators/number_generator.rb

@@ -8,7 +8,7 @@ module Jfuzz
     def generate
       random_number
     end
-    
+
     def self.type
       "number"
     end
@@ -18,12 +18,8 @@ module Jfuzz
     def random_number
       min = minimum
       max = maximum
-      if exclusive_minimum?
-        min + 0.1
-      end
-      if exclusive_maximum?
-        max - 0.1
-      end
+      min + 0.1 if exclusive_minimum?
+      max - 0.1 if exclusive_maximum?
 
       return generate_multiple(min, max) if multiple_of?
 
@@ -33,22 +29,18 @@ module Jfuzz
     def generate_multiple(min, max)
       factor = property.fetch("multipleOf").to_f
 
-      min = min / factor
-      max = max / factor
+      min /= factor
+      max /= factor
       rand(min..max).to_i * factor
     end
 
     def minimum
-      if minimum?
-        return property.fetch("minimum").to_f
-      end
+      return property.fetch("minimum").to_f if minimum?
       Jfuzz.min_integer.to_f
     end
 
     def maximum
-      if maximum?
-        return property.fetch("maximum").to_f
-      end
+      return property.fetch("maximum").to_f if maximum?
       Jfuzz.max_integer.to_f
     end
 

data/lib/jfuzz/generators/string_generator.rb

@@ -4,14 +4,21 @@ require "regexp-examples"
 require "date"
 require "jfuzz/generators/generator"
 
-module Jfuzz 
+module Jfuzz
   class StringGenerator < Generator
-
     DATE = "date"
-    TIME = "time"
     DATE_TIME = "date-time"
 
-    CHARSET = Array('A'..'Z') + Array('a'..'z') + Array(0..9)
+    DATE_REGEXP = /^[0-9]{4}-[0-9]{2}-[0-9]{2}$/
+    TIME_REGEXP = /\A(\d{2}):(\d{2}):(\d{2})\z/	
+    DATE_TIME_REGEXP = /^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](\.[0-9]+)?(Z|[\-+][0-9]{2}:[0-5][0-9])$/
+
+    FORMATS = {
+      DATE => DATE_REGEXP,
+      DATE_TIME => DATE_TIME_REGEXP,
+    }.freeze
+
+    CHARSET = Array("A".."Z") + Array("a".."z") + Array(0..9)
 
     def generate
       if format?
@@ -34,30 +41,18 @@ module Jfuzz
       Array.new(length) { CHARSET.sample }.join
     end
 
+    # rubocop:disable Metrics/AbcSize
     def generate_from_format
-      str = case format
-            when DATE
-              Time.at(rand * Time.now.to_i).to_date.to_s
-            when TIME
-              Time.at(rand * Time.now.to_i).to_datetime.to_s
-            when DATE_TIME
-              Time.at(rand * Time.now.to_i).to_s
-            else
-              raise "Unsupported format: #{format}"
-            end
-
-      if max_length?
-        return str[0..max_length - 1]
-      end
+      str = FORMATS[format].random_example
+      return str[0..max_length - 1] if max_length?
       str
     end
+    # rubocop:enable Metrics/AbcSize
 
     def generate_from_pattern
       str = Regexp.new(pattern).random_example
 
-      if max_length?
-        return str[0..max_length - 1]
-      end
+      return str[0..max_length - 1] if max_length?
       str
     end
 

data/lib/jfuzz/property_fuzzer.rb

@@ -6,10 +6,8 @@ module Jfuzz
       type = type(property)
 
       generator = Jfuzz.generators.fetch(type, nil)
-      if generator.nil?
-        raise "No generator for type #{type}"
-      end
-      
+      raise "No generator for type #{type}" if generator.nil?
+
       generator.new(property, self).try_generate
     end
 
@@ -18,9 +16,7 @@ module Jfuzz
     def type(property)
       t = property["type"]
 
-      if enum?(property)
-        t = "enum"
-      end
+      t = "enum" if enum?(property)
       t
     end
 

data/lib/jfuzz/schema_fuzzer.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "json"
+require "json_schema"
 require "jfuzz/property_fuzzer"
 
 module Jfuzz
@@ -11,14 +12,23 @@ module Jfuzz
     end
 
     def fuzz
-      if schema_path.to_s.nil?
-        raise "Schema path cannot be nil or empty"
-      end
+      raise "Schema path cannot be nil or empty" if schema_path.to_s.nil?
 
       schema_contents = File.read(schema_path)
       schema = JSON.parse(schema_contents)
 
-      property_fuzzer.fuzz_property(schema)
+      fuzzed = property_fuzzer.fuzz_property(schema)
+
+      json_schema = JsonSchema.parse!(schema)
+      is_valid, validation_errors = json_schema.validate(fuzzed)
+
+      unless is_valid
+        raise "Error in the report validation. Produced invalid JSON file " \
+          "according to JSON schema #{schema_path}. " \
+          "Validation errors: #{validation_errors}"
+      end
+
+      fuzzed
     end
 
     private

data/lib/jfuzz/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jfuzz
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jfuzz
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - George Allen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-13 00:00:00.000000000 Z
+date: 2018-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: json_schema
   requirement: !ruby/object:Gem::Requirement