feat: basic importing

Author: dominykas

lib/travis/index.js

@@ -23,7 +23,46 @@ internals.toArray = (v) => {
 };
 
 
-internals.scan = async (travisYaml) => {
+internals.normalizeImports = (travisYaml) => {
+
+    return internals.toArray(travisYaml.import).map((entry) => {
+
+        if (typeof entry === 'string') {
+            entry = { source: entry };
+        }
+
+        return entry;
+    });
+};
+
+
+internals.applyImports = async (yaml, { loadFile }) => {
+
+    if (!yaml.import) {
+        return;
+    }
+
+    const imports = internals.normalizeImports(yaml);
+
+    for (const entry of imports) {
+
+        const buffer = await loadFile(entry.source);
+
+        const imported = Yaml.safeLoad(buffer, {
+            schema: Yaml.FAILSAFE_SCHEMA,
+            json: true
+        });
+
+        for (const key in imported) {
+            yaml[key] = imported[key];
+        }
+    }
+};
+
+
+internals.scan = async (travisYaml, options) => {
+
+    await internals.applyImports(travisYaml, options);
 
     const rawSet = new Set();
 
@@ -35,7 +74,7 @@ internals.scan = async (travisYaml) => {
 
         for (const env of internals.toArray(travisYaml.env.matrix)) {
 
-            const matches = env.match(/(?:NODEJS_VER|TRAVIS_NODE_VERSION|NODE_VER)="?(node\/)?(?<version>[\w./*]+)"?/); /* hack syntax highlighter 🤦‍♂️ */
+            const matches = env.match(/(?:NODEJS_VER|TRAVIS_NODE_VERSION|NODE_VER)="?(node\/)?(?<version>[\w./*]+)"?/);
 
             if (matches) {
                 rawSet.add(matches.groups.version);
@@ -96,6 +135,6 @@ exports.detect = async ({ loadFile }) => {
     });
 
     return {
-        travis: await internals.scan(travisYaml)
+        travis: await internals.scan(travisYaml, { loadFile })
     };
 };

test/fixtures/index.js

@@ -75,7 +75,7 @@ module.exports = class TestContext {
         });
     }
 
-    async setupRepoFolder({ travisYml, packageJson, npmShrinkwrapJson, packageLockJson, git = true } = {}) {
+    async setupRepoFolder({ travisYml, partials, packageJson, npmShrinkwrapJson, packageLockJson, git = true } = {}) {
 
         const tmpObj = Tmp.dirSync({ unsafeCleanup: true });
 
@@ -87,6 +87,13 @@ module.exports = class TestContext {
             Fs.copyFileSync(Path.join(__dirname, 'travis-ymls', travisYml), Path.join(this.path, '.travis.yml'));
         }
 
+        if (partials) {
+            Fs.mkdirSync(Path.join(this.path, 'partials'));
+            for (const fn of ['node-14.yml']) {
+                Fs.copyFileSync(Path.join(__dirname, 'travis-ymls', 'testing-imports', 'partials', fn), Path.join(this.path, 'partials', fn));
+            }
+        }
+
         if (packageJson !== false) {
             Fs.writeFileSync(Path.join(this.path, 'package.json'), JSON.stringify(packageJson || {
                 name: 'test-module',

test/fixtures/travis-ymls/testing-imports/partials/node-14.yml

@@ -0,0 +1,2 @@
+node_js:
+  - "14"

test/fixtures/travis-ymls/testing-imports/simple-array-object.yml

@@ -0,0 +1,3 @@
+language: node_js
+import:
+  - source: partials/node-14.yml

test/fixtures/travis-ymls/testing-imports/simple-array-string.yml

@@ -0,0 +1,3 @@
+language: node_js
+import:
+  - partials/node-14.yml

test/fixtures/travis-ymls/testing-imports/simple-single-object.yml

@@ -0,0 +1,3 @@
+language: node_js
+import:
+  source: partials/node-14.yml

test/fixtures/travis-ymls/testing-imports/simple-single-string.yml

@@ -0,0 +1,2 @@
+language: node_js
+import: partials/node-14.yml

test/travis.js

@@ -0,0 +1,65 @@
+'use strict';
+
+const NodeSupport = require('..');
+
+const TestContext = require('./fixtures');
+
+
+const { describe, it, beforeEach, afterEach } = exports.lab = require('@hapi/lab').script();
+const { expect } = require('@hapi/code');
+
+
+const internals = {};
+
+
+internals.assertCommit = (result) => {
+
+    expect(result.commit).to.match(/^[0-9a-f]{40}$/);
+    delete result.commit;
+};
+
+
+describe('.travis.yml parsing', () => {
+
+    let fixture;
+
+    beforeEach(() => {
+
+        fixture = new TestContext();
+    });
+
+    afterEach(() => {
+
+        fixture.cleanup();
+    });
+
+    describe('simple', () => {
+
+        for (const yml of ['simple-single-object', 'simple-single-string', 'simple-array-object', 'simple-array-string']) {
+
+            // eslint-disable-next-line no-loop-func
+            it(`resolves simple local import (${yml})`, async () => {
+
+                await fixture.setupRepoFolder({
+                    partials: true,
+                    travisYml: `testing-imports/${yml}.yml`
+                });
+
+                const result = await NodeSupport.detect({ path: fixture.path });
+
+                internals.assertCommit(result);
+
+                expect(result).to.equal({
+                    name: 'test-module',
+                    version: '0.0.0-development',
+                    timestamp: 1580673602000,
+                    travis: {
+                        raw: ['14'],
+                        resolved: { '14': '14.3.0' }
+                    }
+                });
+            });
+        }
+    });
+
+});