feat: basic framework + fuzz strings, numbers, bools, and unions

Author: holvonixAdvay

README.md

@@ -1,17 +1,31 @@
-# io-ts-fuzzer - 
+# io-ts-fuzzer - Fuzzing for io-ts codecs and types
 
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE) [![npm](https://img.shields.io/npm/v/io-ts-fuzzer.svg)](https://www.npmjs.com/package/io-ts-fuzzer) [![Build Status](https://travis-ci.com/holvonix-open/io-ts-fuzzer.svg?branch=master)](https://travis-ci.com/holvonix-open/io-ts-fuzzer) [![GitHub last commit](https://img.shields.io/github/last-commit/holvonix-open/io-ts-fuzzer.svg)](https://github.com/holvonix-open/io-ts-fuzzer/commits) [![codecov](https://codecov.io/gh/holvonix-open/io-ts-fuzzer/branch/master/graph/badge.svg)](https://codecov.io/gh/holvonix-open/io-ts-fuzzer) [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=holvonix-open/io-ts-fuzzer)](https://dependabot.com) [![DeepScan grade](https://deepscan.io/api/teams/XX/projects/YY/branches/ZZ/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=XX&pid=YY&bid=ZZ) [![Code Style: Google](https://img.shields.io/badge/code%20style-google-blueviolet.svg)](https://github.com/google/gts) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE) [![npm](https://img.shields.io/npm/v/io-ts-fuzzer.svg)](https://www.npmjs.com/package/io-ts-fuzzer) [![Build Status](https://travis-ci.com/holvonix-open/io-ts-fuzzer.svg?branch=master)](https://travis-ci.com/holvonix-open/io-ts-fuzzer) [![GitHub last commit](https://img.shields.io/github/last-commit/holvonix-open/io-ts-fuzzer.svg)](https://github.com/holvonix-open/io-ts-fuzzer/commits) [![codecov](https://codecov.io/gh/holvonix-open/io-ts-fuzzer/branch/master/graph/badge.svg)](https://codecov.io/gh/holvonix-open/io-ts-fuzzer) [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=holvonix-open/io-ts-fuzzer)](https://dependabot.com) [![DeepScan grade](https://deepscan.io/api/teams/4465/projects/6653/branches/56883/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=4465&pid=6653&bid=56883) [![Code Style: Google](https://img.shields.io/badge/code%20style-google-blueviolet.svg)](https://github.com/google/gts) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
 
 ## Quick Start
 
-After `yarn add io-ts-fuzzer`:
+After `yarn add io-ts io-ts-fuzzer`:
 
 ````typescript
-import { TODO } from 'io-ts-fuzzer';
+import * as t from 'io-ts';
+import * as fuzz from 'io-ts-fuzzer';
 
-async function getIt() {
-  // TODO
+function fuzz() {
+  // Fuzzers for common types
+  const r = fuzz.createCoreRegistry();
+
+  // Type to fuzz
+  const target = t.union([t.string, t.number, t.boolean]);
+
+  // Builds a particular fuzzer from the registry.
+  const fuzzer = fuzz.exampleGenerator(r, target);
+
+  // Make examples.
+  console.log(fuzzer.encode(0));
+  console.log(fuzzer.encode(1));
+  console.log(fuzzer.encode(2));
+  console.log(fuzzer.encode(493));
 }
 ````
 

package.json

@@ -7,7 +7,11 @@
     "url": "https://github.com/holvonix-open/io-ts-fuzzer.git"
   },
   "keywords": [
-    "io-ts", "codecs", "fuzzer", "security"
+    "io-ts",
+    "codecs",
+    "fuzzer",
+    "fuzzing",
+    "security"
   ],
   "engines": {
     "node": "^10.0.0 || ^ 12.0.0",
@@ -22,43 +26,74 @@
     "NOTICE",
     "README.md"
   ],
-  "nyc": {
-    "cache": false,
-    "extension": [
-      ".ts",
-      ".tsx"
-    ],
-    "exclude": [
-      "prettier.config.js",
-      "**/*.d.ts",
-      "test/**/*.*",
-      "build/**/**/*.js"
-    ],
-    "all": true
-  },
   "author": "Holvonix LLC",
   "license": "SEE LICENSE IN LICENSE",
   "private": false,
   "scripts": {
-    "t": "yarn fix && yarn test --grep='#slow' --invert",
-    "cleantests": "rm -rf *.lcov .nyc_output coverage",
-    "clean": "gts clean",
-    "start": "node index.js",
-    "debug": "node --inspect index.js",
-    "cleanstart": "yarn clean; yarn start",
-    "test": "nyc ts-mocha -p ./tsconfig.json 'test/**/*.ts'",
-    "test-coverage": "yarn clean && yarn test && yarn report-coverage",
+    "t": "yarn test  --inspect --grep='#e2e|#int' --invert",
+    "watch:build": "yarn run --silent build:core --watch",
+    "watch:test": "yarn run --silent test-impl --watch --grep='#e2e|#int' --invert -R min",
+    "watch:test-cov": "chokidar --throttle 750 --debounce 500 --silent --initial \"build/**/*.js\" -c \"yarn run --silent watch:test-impl\"",
+    "watch:test-impl": "yarn run --silent test-impl-lcov --grep='#e2e|#int' --invert -R min",
+    "w": "yarn run clean && yarn run build && concurrently --raw -n tsc,mocha \"yarn run --silent watch:build\" \"yarn run --silent watch:test\"",
+    "wc": "yarn run clean && yarn run build && concurrently --raw -n tsc,mocha \"yarn run --silent watch:build\" \"yarn run --silent watch:test-cov\"",
+    "postinstall": "yarn test:postinstall",
+    "build:core": "tsc -p .",
+    "build": "yarn build:core",
+    "clean.builds": "gts clean",
+    "clean": "yarn clean.builds && yarn clean.tests",
+    "clean.tests": "rm -rf *.lcov .nyc_output *.log coverage",
+    "test:postinstall": "yarn clean && yarn build && yarn test-impl --grep='#e2e' --invert",
+    "test": "yarn clean && yarn build && yarn test-impl",
+    "test-impl": "nyc --reporter=text --reporter=lcov mocha",
+    "test-impl-lcov": "nyc --reporter=lcov mocha",
+    "test-coverage": "yarn test && yarn report-coverage",
     "report-coverage": "nyc report --reporter=json && codecov -F unit -f coverage/*.json",
     "lint": "yarn fix && yarn run check",
     "check": "gts check",
-    "compile": "tsc -p .",
     "fix": "gts fix",
-    "prepare": "yarn clean && yarn run check && yarn run compile",
-    "pretest": "yarn run compile",
-    "posttest": "yarn run check",
     "preversion": "yarn test",
+    "docs": "yarn clean && yarn build && rm -rf docs && mkdir -p docs && ( mocha --grep='#private' --invert -R markdown >docs/index.md )",
+    "test-unit": "yarn test --grep='#e2e|#int' --invert",
+    "test-e2e": "yarn test --grep='#e2e'",
+    "test-int": "yarn test --grep='#int'",
+    "up": "yarn upgrade-interactive --latest",
+    "yarn": "rm -rf yarn.lock node_modules/ && yarn",
     "semantic-release": "semantic-release"
   },
+  "husky": {
+    "hooks": {
+      "pre-commit": "yarn clean && yarn run check && yarn test:postinstall"
+    }
+  },
+  "nyc": {
+    "skip-full": true,
+    "cache": false,
+    "extension": [
+      ".ts",
+      ".tsx"
+    ],
+    "require": [
+      "source-map-support/register",
+      "ts-node/register"
+    ],
+    "include": [
+      "src/**/*.ts",
+      "src/**/*.tsx",
+      "build/src/**/*.js",
+      "build/src/**/*.jsx"
+    ],
+    "exclude": [],
+    "all": true
+  },
+  "mocha": {
+    "require": [
+      "source-map-support/register",
+      "ts-node/register"
+    ],
+    "forbid-pending": true,
+    "spec": "./build/test/**/test-*.js"
+  },
   "release": {
     "plugins": [
       [
@@ -97,14 +132,22 @@
       "@semantic-release/github"
     ]
   },
-  "dependencies": {},
+  "dependencies": {
+    "fp-ts": "^2.0.3",
+    "io-ts": "^2.0.0",
+    "io-ts-types": "^0.5.0",
+    "monocle-ts": "^2.0.0"
+  },
   "devDependencies": {
     "@semantic-release/changelog": "^3.0.4",
     "@semantic-release/git": "^7.0.16",
     "@types/mocha": "^5.2.5",
     "@types/node": "^12.6.9",
+    "chokidar-cli": "^2.0.0",
     "codecov": "^3.4.0",
+    "concurrently": "^4.1.1",
     "gts": "^1.1.0",
+    "husky": "^3.0.2",
     "mocha": "^6.2.0",
     "nyc": "^14.1.1",
     "semantic-release": "^15.13.19",

src/core/core.ts

@@ -0,0 +1,103 @@
+import * as t from 'io-ts';
+import { Fuzzer, ConcreteFuzzer, fuzzGenerator } from '../fuzzer';
+
+export type BasicType =
+  | t.NullType
+  | t.UndefinedType
+  | t.VoidType
+  | t.UnknownType
+  | t.StringType
+  | t.NumberType
+  | t.BooleanType
+  | t.AnyArrayType
+  | t.AnyDictionaryType
+  | t.RefinementType<t.Any>
+  | t.LiteralType<string | number | boolean>
+  | t.KeyofType<{ [key: string]: unknown }>
+  | t.RecursiveType<t.Any>
+  | t.ArrayType<t.Any>
+  // tslint:disable-next-line:no-any
+  | t.InterfaceType<any>
+  // tslint:disable-next-line:no-any
+  | t.PartialType<any>
+  | t.DictionaryType<t.Any, t.Any>
+  | t.UnionType<t.Any[]>
+  // tslint:disable-next-line:no-any
+  | t.InterfaceType<any>
+  | t.TupleType<t.Any[]>
+  | t.ReadonlyType<t.Any>
+  | t.ReadonlyArrayType<t.Any>
+  | t.ExactType<t.Any>
+  | t.UnknownType;
+
+export type basicFuzzGenerator<
+  T,
+  C extends t.Decoder<unknown, T> & BasicType
+> = fuzzGenerator<T, C>;
+
+export type basicLiteralConcreteFuzzer<
+  T,
+  C extends t.Decoder<unknown, T> & BasicType
+> = ConcreteFuzzer<T>['func'];
+
+export type BasicFuzzer<
+  T,
+  C extends t.Decoder<unknown, T> & BasicType
+> = Fuzzer<T, C>;
+
+export function concrete<T, C extends t.Decoder<unknown, T> & BasicType>(
+  func: basicLiteralConcreteFuzzer<T, C>,
+  tag: C['_tag']
+): BasicFuzzer<T, C> {
+  return {
+    impl: {
+      type: 'fuzzer',
+      func,
+    },
+    id: tag,
+    idType: 'tag',
+  };
+}
+
+export function gen<T, C extends t.Decoder<unknown, T> & BasicType>(
+  func: basicFuzzGenerator<T, C>,
+  tag: C['_tag']
+): BasicFuzzer<T, C> {
+  return {
+    impl: {
+      type: 'generator',
+      func,
+    },
+    id: tag,
+    idType: 'tag',
+  };
+}
+
+export function fuzzBoolean(n: number) {
+  return n % 2 === 0;
+}
+
+export function fuzzNumber(n: number) {
+  return n;
+}
+
+export function fuzzString(n: number) {
+  return `${n}`;
+}
+
+// tslint:disable-next-line:no-any
+export function fuzzUnion(b: t.UnionC<any>): ConcreteFuzzer<any> {
+  return {
+    children: b.types,
+    func: (n, ...h) => {
+      return h[n % h.length].encode(n);
+    },
+  };
+}
+
+export const coreFuzzers = [
+  concrete(fuzzNumber, 'NumberType'),
+  concrete(fuzzBoolean, 'BooleanType'),
+  concrete(fuzzString, 'StringType'),
+  gen(fuzzUnion, 'UnionType'),
+];

src/core/index.ts

@@ -0,0 +1 @@
+export { coreFuzzers } from './core';

src/fuzzer.ts

@@ -0,0 +1,70 @@
+import * as t from 'io-ts';
+import { Registry } from './registry';
+
+export interface Fuzzer<T, C extends t.Decoder<unknown, T>> {
+  id: string;
+  idType: 'name' | 'tag';
+  impl: FuzzerGenerator<T, C> | ImmediateConcreteFuzzer<T>;
+}
+
+export interface FuzzerGenerator<T, C extends t.Decoder<unknown, T>> {
+  type: 'generator';
+  func: fuzzGenerator<T, C>;
+}
+
+export interface ImmediateConcreteFuzzer<T> extends ConcreteFuzzer<T> {
+  type: 'fuzzer';
+}
+
+export interface ConcreteFuzzer<T> {
+  children?: Array<t.Decoder<unknown, unknown>>;
+
+  // tslint:disable-next-line:no-any
+  func: (n: number, ...h: Array<ExampleGenerator<any>>) => T;
+}
+
+export type fuzzGenerator<T, C extends t.Decoder<unknown, T>> = (
+  b: C
+) => ConcreteFuzzer<T>;
+
+/**
+ * Given a number, generates a pseudorandom (but deterministic)
+ * instance of T.
+ */
+export type ExampleGenerator<T> = t.Encoder<number, T>;
+
+export function exampleOf<T>(
+  d: t.Decoder<unknown, T>,
+  r: Registry,
+  a: number
+): T {
+  return exampleGenerator(r, d).encode(a);
+}
+
+export function exampleGeneratorFromConcreteFuzzer<T>(
+  r: Registry,
+  fi: ConcreteFuzzer<T>
+): ExampleGenerator<T> {
+  const k = fi.func;
+  const children = fi.children
+    ? fi.children.map(x => exampleGenerator(r, x))
+    : [];
+  return {
+    encode: a => k(a, ...children),
+  };
+}
+
+export function exampleGenerator<T>(
+  r: Registry,
+  d: t.Decoder<unknown, T>
+): ExampleGenerator<T> {
+  const f = r.getFuzzer(d);
+  if (!f) {
+    throw new RangeError(`no fuzzer for ${d.name}`);
+  }
+  const fi = f.impl;
+  return exampleGeneratorFromConcreteFuzzer(
+    r,
+    fi.type === 'fuzzer' ? fi : fi.func(d)
+  );
+}

src/index.ts

@@ -21,6 +21,6 @@ limitations under the License.
 Third-party dependencies may have their own licenses.
 */
 
-export function todo() {
-  return true;
-}
+export * from './registry';
+export * from './fuzzer';
+export * from './core/';