From 549e6d57c44abcd7e59699f739027d190d4e3bd7 Mon Sep 17 00:00:00 2001
From: Leonid Logvinov <logvinov.leon@gmail.com>
Date: Thu, 24 May 2018 16:33:58 -0700
Subject: Add schema assertions on public methods of @0xproject/sol-compiler

---
 packages/sol-compiler/package.json                 |  1 +
 packages/sol-compiler/src/cli.ts                   |  2 +-
 packages/sol-compiler/src/compiler.ts              |  5 +++++
 .../src/schemas/compiler_options_schema.ts         | 26 ++++++++++++++++++++++
 4 files changed, 33 insertions(+), 1 deletion(-)
 create mode 100644 packages/sol-compiler/src/schemas/compiler_options_schema.ts

(limited to 'packages/sol-compiler')

diff --git a/packages/sol-compiler/package.json b/packages/sol-compiler/package.json
index 7e55d718d..a74e4ae3e 100644
--- a/packages/sol-compiler/package.json
+++ b/packages/sol-compiler/package.json
@@ -72,6 +72,7 @@
         "zeppelin-solidity": "1.8.0"
     },
     "dependencies": {
+        "@0xproject/assert": "0.2.10",
         "@0xproject/json-schemas": "0.7.22",
         "@0xproject/sol-resolver": "^0.0.5",
         "@0xproject/types": "^0.7.0",
diff --git a/packages/sol-compiler/src/cli.ts b/packages/sol-compiler/src/cli.ts
index d107e8b37..b97cf4cab 100644
--- a/packages/sol-compiler/src/cli.ts
+++ b/packages/sol-compiler/src/cli.ts
@@ -35,7 +35,7 @@ const SEPARATOR = ',';
         : argv.contracts === DEFAULT_CONTRACTS_LIST
             ? DEFAULT_CONTRACTS_LIST
             : argv.contracts.split(SEPARATOR);
-    const opts: CompilerOptions = {
+    const opts = {
         contractsDir: argv.contractsDir,
         artifactsDir: argv.artifactsDir,
         contracts,
diff --git a/packages/sol-compiler/src/compiler.ts b/packages/sol-compiler/src/compiler.ts
index 2ebc5228e..d063b27a1 100644
--- a/packages/sol-compiler/src/compiler.ts
+++ b/packages/sol-compiler/src/compiler.ts
@@ -1,3 +1,5 @@
+import { assert } from '@0xproject/assert';
+import { schemas } from '@0xproject/json-schemas';
 import {
     ContractSource,
     ContractSources,
@@ -22,6 +24,7 @@ import * as requireFromString from 'require-from-string';
 import * as semver from 'semver';
 import solc = require('solc');
 
+import { compilerOptionsSchema } from './schemas/compiler_options_schema';
 import { binPaths } from './solc/bin_paths';
 import {
     createDirIfDoesNotExistAsync,
@@ -81,10 +84,12 @@ export class Compiler {
      * @return An instance of the Compiler class.
      */
     constructor(opts: CompilerOptions) {
+        assert.doesConformToSchema('opts', opts, compilerOptionsSchema);
         // TODO: Look for config file in parent directories if not found in current directory
         const config: CompilerOptions = fs.existsSync(CONFIG_FILE)
             ? JSON.parse(fs.readFileSync(CONFIG_FILE).toString())
             : {};
+        assert.doesConformToSchema('compiler.json', config, compilerOptionsSchema);
         this._contractsDir = opts.contractsDir || config.contractsDir || DEFAULT_CONTRACTS_DIR;
         this._solcVersionIfExists = opts.solcVersion || config.solcVersion;
         this._compilerSettings = opts.compilerSettings || config.compilerSettings || DEFAULT_COMPILER_SETTINGS;
diff --git a/packages/sol-compiler/src/schemas/compiler_options_schema.ts b/packages/sol-compiler/src/schemas/compiler_options_schema.ts
new file mode 100644
index 000000000..43a9c0879
--- /dev/null
+++ b/packages/sol-compiler/src/schemas/compiler_options_schema.ts
@@ -0,0 +1,26 @@
+export const compilerOptionsSchema = {
+    id: '/CompilerOptions',
+    properties: {
+        contractsDir: { type: 'string' },
+        artifactsDir: { type: 'string' },
+        solcVersion: { type: 'string', pattern: '^d+.d+.d+$' },
+        compilerSettings: { type: 'object' },
+        contracts: {
+            oneOf: [
+                {
+                    type: 'string',
+                    pattern: '^\\*$',
+                },
+                {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                },
+            ],
+        },
+    },
+    type: 'object',
+    required: [],
+    additionalProperties: false,
+};
-- 
cgit v1.2.3