Merge pull request #88 from electricimp/develop

Version 3.2.0 Release

Author: zandr

Diff for: README.md

@@ -1,6 +1,6 @@
 {
   "name": "Builder",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "Builder Language Implementation",
   "main": "src/index.js",
   "bin": {
@@ -9,6 +9,7 @@
   "scripts": {
     "test": "jasmine",
     "test:bitbucket-server": "node ./spec/BitbucketServerExecutor.js",
+    "test:azure-repos": "node ./spec/AzureReposExecutor.js",
     "build": "src/cli.js input"
   },
   "repository": {

Diff for: package-lock.json

@@ -0,0 +1,65 @@
+// MIT License
+//
+// Copyright 2020 Electric Imp
+//
+// SPDX-License-Identifier: MIT
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+// EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
+// OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+// OTHER DEALINGS IN THE SOFTWARE.
+
+'use strict';
+
+const fs = require('fs');
+const Log = require('log');
+const eol = require('eol');
+const AzureReposReader = require('../../src/Readers/AzureReposReader');
+
+describe('AzureReposReader', () => {
+  let reader;
+
+  beforeEach(function() {
+    if (!process.env.SPEC_AZURE_REPOS_REPO_PATH) {
+      fail('Some of the required environment variables are not set');
+      return;
+    }
+
+    reader = new AzureReposReader();
+
+    // @see https://www.npmjs.com/package/log#log-levels
+    reader.logger = new Log(process.env.SPEC_LOGLEVEL || 'error');
+    reader.username = process.env.SPEC_AZURE_REPOS_USERNAME;
+    reader.token = process.env.SPEC_AZURE_REPOS_TOKEN;
+  });
+
+  it('should read sample#1 from Azure Repos', () => {
+    let remote;
+    const local = eol.lf(fs.readFileSync(__dirname + '/../fixtures/sample-1/input.nut', 'utf-8'));
+
+    remote = reader.read(`git-azure-repos:${process.env.SPEC_AZURE_REPOS_REPO_PATH}/spec/fixtures/sample-1/input.nut`);
+    expect(remote).toEqual(local);
+
+    remote = reader.read(`git-azure-repos:${process.env.SPEC_AZURE_REPOS_REPO_PATH}/spec/fixtures/sample-1/input.nut@master`);
+    expect(remote).toEqual(local);
+
+    remote = reader.read(`git-azure-repos:${process.env.SPEC_AZURE_REPOS_REPO_PATH}/./spec/../spec/fixtures/sample-1/input.nut`);
+    expect(remote).toEqual(local);
+
+    remote = reader.read(`git-azure-repos:${process.env.SPEC_AZURE_REPOS_REPO_PATH}/./spec/../spec/fixtures/sample-1/input.nut@master`);
+    expect(remote).toEqual(local);
+  });
+});

Diff for: package.json

@@ -0,0 +1,62 @@
+// MIT License
+//
+// Copyright 2020 Electric Imp
+//
+// SPDX-License-Identifier: MIT
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+// EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
+// OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+// OTHER DEALINGS IN THE SOFTWARE.
+
+'use strict';
+
+const fs = require('fs');
+const Log = require('log');
+const eol = require('eol');
+const AzureReposReader = require('../../src/Readers/AzureReposReader');
+
+describe('AzureReposReader', () => {
+  let reader;
+
+  beforeEach(function() {
+    if (!process.env.SPEC_AZURE_REPOS_REPO_PATH) {
+      fail('Some of the required environment variables are not set');
+      return;
+    }
+
+    reader = new AzureReposReader();
+
+    // @see https://www.npmjs.com/package/log#log-levels
+    reader.logger = new Log(process.env.SPEC_LOGLEVEL || 'error');
+    reader.username = process.env.SPEC_AZURE_REPOS_USERNAME;
+    reader.token = process.env.SPEC_AZURE_REPOS_TOKEN;
+  });
+
+  it('should read sample#1 from Azure Repos with refs', () => {
+    let remote;
+    const local = eol.lf(fs.readFileSync(__dirname + '/../fixtures/sample-1/input.nut', 'utf-8'));
+
+    remote = reader.read(`git-azure-repos:${process.env.SPEC_AZURE_REPOS_REPO_PATH}/spec/fixtures/sample-1/input.nut@master`);
+    expect(remote).toEqual(local);
+
+    remote = reader.read(`git-azure-repos:${process.env.SPEC_AZURE_REPOS_REPO_PATH}/spec/fixtures/sample-1/input.nut@v0.1.0`);
+    expect(remote).toEqual(local);
+
+    remote = reader.read(`git-azure-repos:${process.env.SPEC_AZURE_REPOS_REPO_PATH}/spec/fixtures/sample-1/input.nut@d390dbe849da349e29db850779173887c5e9babd`);
+    expect(remote).toEqual(local);
+  });
+});

Diff for: spec/AzureRepos/AzureReposReader.spec.js

@@ -0,0 +1,101 @@
+// MIT License
+//
+// Copyright 2020 Electric Imp
+//
+// SPDX-License-Identifier: MIT
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+// EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
+// OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+// OTHER DEALINGS IN THE SOFTWARE.
+
+'use strict';
+
+require('jasmine-expect');
+
+const fs = require('fs');
+const Log = require('log');
+const Builder = require('../../src/');
+
+describe('FileCache', () => {
+  let machine;
+
+  beforeEach(() => {
+    if (!process.env.SPEC_AZURE_REPOS_REPO_PATH) {
+      fail('Some of the required environment variables are not set');
+      return;
+    }
+
+    const builder = new Builder();
+    builder.logger = new Log(process.env.SPEC_LOGLEVEL || 'error');
+    builder.machine.readers.azureRepos.username = process.env.SPEC_AZURE_REPOS_USERNAME;
+    builder.machine.readers.azureRepos.token = process.env.SPEC_AZURE_REPOS_TOKEN;
+    machine = builder.machine;
+
+    machine.fileCache.cacheDir = './test-cache';
+  });
+
+  afterEach(() => {
+    if (!machine) {
+      return;
+    }
+
+    if (fs.existsSync(machine.fileCache.cacheDir)) {
+      machine.clearCache();
+    }
+  });
+
+  it('should not read cached files when cache option is off', () => {
+    let link = `git-azure-repos:${process.env.SPEC_AZURE_REPOS_REPO_PATH}/spec/fixtures/sample-11/LineBrakeSample.nut`;
+    machine.useCache = false;
+    machine.fileCache._cacheFile(link, 'cached');
+    expect(machine.execute(`@include '${link}'`)).not.toEqual('cached');
+  });
+
+  it('should cache files in machine', () => {
+    let link = `git-azure-repos:${process.env.SPEC_AZURE_REPOS_REPO_PATH}/spec/fixtures/sample-11/LineBrakeSample.nut`;
+    machine.useCache = true;
+    machine.execute(`@include '${link}'`);
+    expect(machine.fileCache._findFile(link)).toBeTruthy();
+  });
+
+  it('should exclude remote files from cache', () => {
+    machine.useCache = true;
+    let linkName = `git-azure-repos:${process.env.SPEC_AZURE_REPOS_REPO_PATH}/spec/fixtures/sample-11/LineBrakeSample.nut`;
+    expect(machine.fileCache._findFile(linkName)).toEqual(false);
+    machine.excludeList = __dirname + '/../fixtures/config/exclude-all.exclude';
+    machine.execute(`@include '${linkName}'`);
+    expect(machine.fileCache._findFile(linkName)).toEqual(false);
+  });
+
+  it('should generate unique paths for different Azure Repos links', () => {
+    const linksSet = new Set();
+    const links = ['git-azure-repos:a/b/c.js',
+                   'git-azure-repos:b/a/c.js',
+                   'git-azure-repos:a/b/c.js@a',
+                   'git-azure-repos:a/b/c.j@s',
+                   'git-azure-repos:a/b/a-b-c.js',
+                   'git-azure-repos:a/b-c_js/c.js',
+                   'git-azure-repos:a/b/c_js.js',
+                   'git-azure-repos:a/b/c/js'
+                  ];
+    links.forEach(link => {
+      const path = machine.fileCache._getCachedPath(link);
+      expect(linksSet.has(path)).toEqual(false);
+      linksSet.add(path);
+    });
+  });
+});

Diff for: spec/AzureRepos/branches-tags-commits.spec.js

@@ -0,0 +1,88 @@
+// MIT License
+//
+// Copyright 2020 Electric Imp
+//
+// SPDX-License-Identifier: MIT
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+// EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
+// OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+// OTHER DEALINGS IN THE SOFTWARE.
+
+'use strict';
+
+require('jasmine-expect');
+
+const fs = require('fs');
+const path = require('path');
+const eol = require('eol');
+const Log = require('log');
+const Builder = require('../../src/');
+
+const dependenciesFile = path.join(process.cwd(), 'save_dependencies.json');
+
+describe('Machine', () => {
+  let machine;
+
+  beforeEach(function () {
+    if (!process.env.SPEC_AZURE_REPOS_REPO_PATH) {
+      fail('Some of the required environment variables are not set');
+      return;
+    }
+
+    const builder = new Builder();
+    builder.logger = new Log(process.env.SPEC_LOGLEVEL || 'error');
+    builder.machine.readers.azureRepos.username = process.env.SPEC_AZURE_REPOS_USERNAME;
+    builder.machine.readers.azureRepos.token = process.env.SPEC_AZURE_REPOS_TOKEN;
+    machine = builder.machine;
+  });
+
+  it('Create and read dependencies JSON file', () => {
+    const rev1CommitID = "618bb5ecb831762ed085486f39496502f7b22700";
+    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 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 = `git-azure-repos:${process.env.SPEC_AZURE_REPOS_REPO_PATH}/spec/fixtures/sample-1/input.nut.out@v2.2.2`;
+
+    // ensure that test dependencies JSON file does not exist
+    if (fs.existsSync(dependenciesFile)) {
+      fs.unlinkSync(dependenciesFile);
+    }
+
+    machine.dependenciesSaveFile = dependenciesFile;
+    expect(eol.lf(machine.execute(`@include "${url}"`))).toBe(rev1Content);
+
+    // check dependencies JSON file content
+    const rev1Map = new Map(JSON.parse(fs.readFileSync(dependenciesFile)));
+    expect(rev1Map.size).toEqual(1);
+    expect(rev1Map.get(url)).toEqual(rev1CommitID);
+
+    // replace the actual (rev1) commit ID to rev0 commit ID
+    rev1Map.set(url, rev0CommitID);
+    fs.writeFileSync(dependenciesFile, JSON.stringify([...rev1Map], null, 2), 'utf-8');
+
+    machine.dependenciesUseFile = dependenciesFile;
+    expect(eol.lf(machine.execute(`@include "${url}"`))).toBe(rev0Content);
+
+    // check dependencies JSON file content again
+    const rev0Map = new Map(JSON.parse(fs.readFileSync(dependenciesFile)));
+    expect(rev0Map.size).toEqual(1);
+    expect(rev0Map.get(url)).toEqual(rev0CommitID);
+
+    // unlink dependencies file to avoid conflicts with unit-tests below
+    fs.unlinkSync(dependenciesFile);
+  });
+});