Develop

package.json

@@ -1,6 +1,6 @@
 {
   "name": "Builder",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "Builder Language Implementation",
   "main": "src/index.js",
   "bin": {
@@ -22,8 +22,9 @@
   "homepage": "https://github.com/electricimp/Builder#readme",
   "dependencies": {
     "clone": "^1.0.2",
-    "@octokit/rest": "^15.2.6",
+    "@octokit/rest": "^16.20.0",
     "glob": "^7.1.2",
+    "https-proxy-agent": "^2.2.1",
     "jsep": "^0.3.1",
     "request": "^2.71.0",
     "md5": "^2.2.1",

spec/Machine/suppress-duplicate.spec.js

@@ -44,7 +44,7 @@ describe('Machine', () => {
 
       machine.suppressDupWarning = false;
       const res = eol.lf(machine.execute(
-      `@include once "${backslashToSlash(__dirname)}/../fixtures/lib/a.builder"
+        `@include once "${backslashToSlash(__dirname)}/../fixtures/lib/a.builder"
 @include once "${backslashToSlash(__dirname)}/../fixtures/lib/a.builder_copy"`
       ));
       expect(res).toEqual(`a.builder\na.builder\n`);
@@ -64,10 +64,10 @@ describe('Machine', () => {
       });
 
       const res = eol.lf(machine.execute(
-      `@include once "${backslashToSlash(__dirname)}/../fixtures/lib/a.builder"
+        `@include once "${backslashToSlash(__dirname)}/../fixtures/lib/a.builder"
 @include once "${backslashToSlash(__dirname)}/../fixtures/lib/a.builder_copy"`
       ));
-        expect(res).toEqual(`a.builder\na.builder\n`);
+      expect(res).toEqual(`a.builder\na.builder\n`);
     } catch (e) {
       fail(e);
     }

spec/Machine/use-dependencies.spec.js

@@ -0,0 +1,152 @@
+// Copyright (c) 2016-2019 Electric Imp
+// This file is licensed under the MIT License
+// http://opensource.org/licenses/MIT
+
+'use strict';
+
+require('jasmine-expect');
+
+const fs = require('fs');
+const path = require('path');
+const Fixture = require('fixture-stdout');
+const stderrFixture = new Fixture({ stream: process.stderr });
+const init = require('./init')('main');
+const eol = require('eol');
+const backslashToSlash = require('../backslashToSlash');
+
+const dependenciesUseFile = path.join(process.cwd(), 'use_dependencies.json');
+const dependenciesSaveFile = path.join(process.cwd(), 'save_dependencies.json');
+
+describe('Machine', () => {
+  let machine;
+
+  beforeEach(() => {
+    machine = init.createMachine();
+  });
+
+  it('Create and read dependencies JSON file', () => {
+    const rev1GitBlobID = "c22db87f08ae30a4a0d3450daabb34029b3d50e7";
+    const rev1Content = "// included file a\n// included file b\n\n\n  // should be included\n\n    // l2 else\n\n\n  // should be included\n";
+    const rev0GitBlobID = "9db26aa9017943a7812ab6751a699cd1c7247370";
+    const rev0Content = "// included file a\n    // included file b\n\n\n      // should be included\n\n        // l2 else\n\n\n      // should be included\n";
+    const url = 'github:nobitlost/Builder/spec/fixtures/sample-1/input.nut.out';
+
+    // ensure that test dependencies JSON file does not exist
+    if (fs.existsSync(dependenciesSaveFile)) {
+      fs.unlinkSync(dependenciesSaveFile);
+    }
+
+    machine.dependenciesSaveFile = dependenciesSaveFile;
+    expect(eol.lf(machine.execute(`@include "${url}"`))).toBe(rev1Content);
+
+    // check dependencies JSON file content
+    const rev1Map = new Map(JSON.parse(fs.readFileSync(dependenciesSaveFile)));
+    expect(rev1Map.size).toEqual(1);
+    expect(rev1Map.get(url)).toEqual(rev1GitBlobID);
+
+    // replace the actual commit ID to previous
+    rev1Map.set(url, rev0GitBlobID);
+    fs.writeFileSync(dependenciesSaveFile, JSON.stringify([...rev1Map], null, 2), 'utf-8');
+
+    machine.dependenciesUseFile = dependenciesSaveFile;
+    expect(eol.lf(machine.execute(`@include "${url}"`))).toBe(rev0Content);
+
+    // check dependencies JSON file content again
+    const rev0Map = new Map(JSON.parse(fs.readFileSync(dependenciesSaveFile)));
+    expect(rev0Map.size).toEqual(1);
+    expect(rev0Map.get(url)).toEqual(rev0GitBlobID);
+
+    // unlink dependencies file to avoid conflicts with unit-tests below
+    fs.unlinkSync(dependenciesSaveFile);
+  });
+
+  it('Check dependencies JSON if github ref already provided', () => {
+    const rev0GitBlobID = "9db26aa9017943a7812ab6751a699cd1c7247370";
+    const rev0CommitID = "e2a5b434b34b5737b2ff52f51a92c5bbcc9f83bf";
+    const rev0Content = "// included file a\n    // included file b\n\n\n      // should be included\n\n        // l2 else\n\n\n      // should be included\n";
+    const url = `github:nobitlost/Builder/spec/fixtures/sample-1/input.nut.out@${rev0CommitID}`;
+
+    // ensure that test dependencies JSON file does not exist
+    if (fs.existsSync(dependenciesSaveFile)) {
+      fs.unlinkSync(dependenciesSaveFile);
+    }
+
+    machine.dependenciesSaveFile = dependenciesSaveFile;
+    expect(eol.lf(machine.execute(`@include "${url}"`))).toBe(rev0Content);
+
+    // check dependencies JSON file content again
+    const rev0Map = new Map(JSON.parse(fs.readFileSync(dependenciesSaveFile)));
+    expect(rev0Map.size).toEqual(1);
+    expect(rev0Map.get(url)).toEqual(rev0GitBlobID);
+
+    // unlink dependencies file to avoid conflicts with unit-tests below
+    fs.unlinkSync(dependenciesSaveFile);
+  });
+
+  it('Check ---save-dependecies/--use-dependencies options combination', () => {
+    const rev1Content = "// included file a\n// included file b\n\n\n  // should be included\n\n    // l2 else\n\n\n  // should be included\n";
+    const url = `github:nobitlost/Builder/spec/fixtures/sample-1/input.nut.out`;
+
+    // ensure that test dependencies JSON file does not exist
+    if (fs.existsSync(dependenciesUseFile)) {
+      fs.unlinkSync(dependenciesUseFile);
+    }
+
+    machine.dependenciesSaveFile = dependenciesUseFile;
+    expect(eol.lf(machine.execute(`@include "${url}"`))).toBe(rev1Content);
+
+    // check that dependencies JSON file was created
+    if (!fs.existsSync(dependenciesUseFile)) {
+      fail(`The ${dependenciesUseFile} file does not exist.`);
+    }
+
+    machine.dependenciesUseFile = dependenciesUseFile;
+    machine.dependenciesSaveFile = dependenciesSaveFile;
+    expect(eol.lf(machine.execute(`@include "${url}"`))).toBe(rev1Content);
+
+    // check that dependencies JSON file was created
+    if (!fs.existsSync(dependenciesSaveFile)) {
+      fail(`The ${dependenciesSaveFile} file does not exist.`);
+    }
+
+    // check that files are identical
+    expect(fs.readFileSync(dependenciesUseFile)).toEqual(fs.readFileSync(dependenciesSaveFile));
+
+    // unlink directives file to avoid conflicts with unit-tests below
+    fs.unlinkSync(dependenciesSaveFile);
+    fs.unlinkSync(dependenciesUseFile);
+  });
+
+  it('Check case when dependencies JSON file is corrupted', () => {
+    const rev1Content = "// included file a\n// included file b\n\n\n  // should be included\n\n    // l2 else\n\n\n  // should be included\n";
+    const url = `github:nobitlost/Builder/spec/fixtures/sample-1/input.nut.out`;
+
+    // ensure that test dependencies JSON file does not exist
+    if (fs.existsSync(dependenciesSaveFile)) {
+      fs.unlinkSync(dependenciesSaveFile);
+    }
+
+    machine.dependenciesSaveFile = dependenciesSaveFile;
+    expect(eol.lf(machine.execute(`@include "${url}"`))).toBe(rev1Content);
+
+    // Check dependencies JSON file content again
+    const rev0Map = new Map(JSON.parse(fs.readFileSync(dependenciesSaveFile)));
+    expect(rev0Map.size).toEqual(1);
+
+    // corrupt the file
+    fs.appendFileSync(dependenciesSaveFile, ']');
+
+    const fileCorruptedMessage = `The dependencies JSON file '${dependenciesSaveFile}' cannot be used: Unexpected token ] in JSON at position 127`;
+
+    // check exception error message
+    try {
+      machine.dependenciesUseFile = dependenciesSaveFile;
+      expect(eol.lf(machine.execute(`@include "${url}"`))).toBe(rev1Content);
+    } catch (e) {
+      expect(e.message).toEqual(fileCorruptedMessage);
+    }
+
+    // unlink directives file to avoid conflicts with unit-tests below
+    fs.unlinkSync(dependenciesSaveFile);
+  });
+});

spec/Machine/use-directives.spec.js

@@ -0,0 +1,175 @@
+// Copyright (c) 2016-2019 Electric Imp
+// This file is licensed under the MIT License
+// http://opensource.org/licenses/MIT
+
+'use strict';
+
+require('jasmine-expect');
+
+const fs = require('fs');
+const path = require('path');
+const init = require('./init')('main');
+const eol = require('eol');
+
+const directivesUseFile = path.join(process.cwd(), 'use_directives.json');
+const directivesSaveFile = path.join(process.cwd(), 'save_directives.json');
+
+describe('Machine', () => {
+  let machine;
+
+  beforeEach(() => {
+    machine = init.createMachine();
+  });
+
+  it('Create and read directives JSON file', () => {
+    const directives = {
+      IntType: 34,
+      FloatType: 34.456,
+      ExponentType1: 3E4,
+      ExponentType2: 3e-2,
+      StringType1: "str1",
+      StringType2: "\"str2\"",
+      BoolTypeTrue: true,
+      BoolTypeFalse: false,
+      NullType: null
+    };
+
+    const directivesSource = "@{IntType} @{FloatType} @{ExponentType1} @{ExponentType2} @{StringType1} @{StringType2} @{BoolTypeTrue} @{BoolTypeFalse} @{NullType}";
+    const expectedOutput = `34 34.456 30000 0.03 str1 "str2" true false null`;
+
+    // ensure that test JSON file does not exist
+    if (fs.existsSync(directivesSaveFile)) {
+      fs.unlinkSync(directivesSaveFile);
+    }
+
+    // create directives file
+    machine.directivesSaveFile = directivesSaveFile;
+    expect(eol.lf(machine.execute(directivesSource, directives))).toBe(expectedOutput);
+
+    // check that JSON file was created
+    if (!fs.existsSync(directivesSaveFile)) {
+      fail(`The ${directivesSaveFile} file does not exist.`);
+    }
+
+    // check that we are able to read variables definitions from JSON file
+    machine.directivesUseFile = directivesSaveFile;
+    expect(eol.lf(machine.execute(directivesSource))).toBe(expectedOutput);
+
+    // unlink directives file to avoid conflicts with unit-tests below
+    fs.unlinkSync(directivesSaveFile);
+  });
+
+  it('Check that directives JSON file content is able to be merged with additional variable definitions', () => {
+    const directives = {
+      Int0: 990,
+      Int1: 991,
+    };
+
+    const directivesSource = "@{Int0} @{Int1}";
+    const expectedOutput = `990 991`;
+
+    // ensure that test directives JSON file does not exist
+    if (fs.existsSync(directivesSaveFile)) {
+      fs.unlinkSync(directivesSaveFile);
+    }
+
+    // create directives file
+    machine.directivesSaveFile = directivesSaveFile;
+    expect(eol.lf(machine.execute(directivesSource, directives))).toBe(expectedOutput);
+
+    // check that JSON file was created
+    if (!fs.existsSync(directivesSaveFile)) {
+      fail(`The ${directivesSaveFile} file does not exist.`);
+    }
+
+    // check that we are able to read variables definitions from JSON file
+    machine.directivesUseFile = directivesSaveFile;
+    expect(eol.lf(machine.execute(directivesSource + " @{Int2}", {Int2: 992}))).toBe(expectedOutput + " 992");
+
+    // unlink directives file to avoid conflicts with unit-tests below
+    fs.unlinkSync(directivesSaveFile);
+  });
+
+  it('Check ---save-directives/--use-directives options combination', () => {
+    const directives = {
+      Int0: 550,
+      Int1: 551,
+      Int2: 552,
+    };
+
+    const directivesSource = "@{Int0} @{Int1} @{Int2}";
+    const expectedOutput = `550 551 552`;
+
+    // ensure that test JSON file does not exist
+    if (fs.existsSync(directivesSaveFile)) {
+      fs.unlinkSync(directivesSaveFile);
+    }
+
+    // create directives file
+    machine.directivesSaveFile = directivesUseFile;
+    expect(eol.lf(machine.execute(directivesSource, directives))).toBe(expectedOutput);
+
+    // check that directives JSON file was created
+    if (!fs.existsSync(directivesUseFile)) {
+      fail(`The ${directivesUseFile} file does not exist.`);
+    }
+
+    machine.directivesUseFile = directivesUseFile;
+    machine.directivesSaveFile = directivesSaveFile;
+    eol.lf(machine.execute(directivesSource, directives));
+
+    // check that directives JSON file was created
+    if (!fs.existsSync(directivesSaveFile)) {
+      fail(`The ${directivesSaveFile} file does not exist.`);
+    }
+
+    // check that files are identical
+    expect(fs.readFileSync(directivesUseFile)).toEqual(fs.readFileSync(directivesSaveFile));
+
+    // unlink directives file to avoid conflicts with unit-tests below
+    fs.unlinkSync(directivesSaveFile);
+    fs.unlinkSync(directivesUseFile);
+  });
+
+  it('Check case when directives JSON file appear to be corrupted', () => {
+    const directives = {
+      Int0: 550,
+      Int1: 551,
+      Int2: 552,
+    };
+
+    const directivesSource = "@{Int0} @{Int1} @{Int2}";
+    const expectedOutput = `550 551 552`;
+
+    // ensure that test JSON file does not exist
+    if (fs.existsSync(directivesSaveFile)) {
+      fs.unlinkSync(directivesSaveFile);
+    }
+
+    // create directives file
+    machine.directivesSaveFile = directivesSaveFile;
+    expect(eol.lf(machine.execute(directivesSource, directives))).toBe(expectedOutput);
+
+    // check that directives JSON file was created
+    if (!fs.existsSync(directivesSaveFile)) {
+      fail(`The ${directivesSaveFile} file does not exist.`);
+    }
+
+    // corrupt the file
+    fs.appendFileSync(directivesSaveFile, ']');
+
+    const fileCorruptedMessage = `The directives JSON file '${directivesSaveFile}' cannot be used: Unexpected token ] in JSON at position 47`;
+
+    // check exception error message
+    try {
+      machine.directivesSaveFile = undefined;
+      machine.directivesUseFile = directivesSaveFile;
+      eol.lf(machine.execute(directivesSource, directives));
+    } catch (e) {
+      expect(e.message).toEqual(fileCorruptedMessage);
+    }
+
+    // unlink directives file to avoid conflicts with unit-tests below
+    fs.unlinkSync(directivesSaveFile);
+  });
+});

spec/fixtures/lib/g.builder

@@ -0,0 +1 @@
+g.builder.rev1