test: add tests for formatters and e2e

Author: oss6

.gitignore

@@ -118,3 +118,5 @@ dist
 .DS_Store
 
 .note/
+
+vf-core-service-discovery-e2e-projects/

e2e/basic.test.ts

@@ -0,0 +1,30 @@
+import path from 'path';
+import test from 'ava';
+import execa from 'execa';
+import rimraf from 'rimraf';
+import { promisify } from 'util';
+
+const rimrafP = promisify(rimraf);
+
+test.serial.before(async () => {
+  await rimrafP('vf-core-service-discovery-e2e-projects');
+  await execa('git', ['clone', 'https://github.com/oss6/vf-core-service-discovery-e2e-projects']);
+});
+
+test.serial('basic e2e', async (t) => {
+  // arrange
+  const testExampleDirectory = path.join('vf-core-service-discovery-e2e-projects', 'basic');
+  const tsNodeFileName = path.resolve(path.join('node_modules', '.bin', 'ts-node'));
+  const cliFileName = path.resolve(path.join('src', 'cli', 'index.ts'));
+  const tsConfigFileName = path.resolve('tsconfig.json');
+
+  // act
+  const { stdout } = await execa(tsNodeFileName, ['--project', tsConfigFileName, cliFileName, 'run'], {
+    cwd: testExampleDirectory,
+  });
+
+  // assert
+  t.true(stdout.includes('vf-box'));
+  t.true(stdout.includes('vf-footer'));
+  t.true(stdout.includes('vf-grid'));
+});

package.json

@@ -50,6 +50,7 @@
     "eslint": "^7.15.0",
     "eslint-config-prettier": "^7.0.0",
     "eslint-plugin-prettier": "^3.3.0",
+    "execa": "^5.0.0",
     "fetch-mock": "^9.11.0",
     "husky": "^4.3.8",
     "nyc": "^15.1.0",
@@ -79,8 +80,10 @@
   },
   "ava": {
     "files": [
+      "e2e/**",
       "test/**",
-      "!test/fixture/**"
+      "!test/fixture/**",
+      "!e2e/vf-core-service-discovery-e2e-projects/**"
     ],
     "extensions": [
       "ts"

src/helpers/string.ts

@@ -26,13 +26,3 @@ export class StringBuilder {
     return this.value;
   }
 }
-
-// const stringBuilder = {
-//   value: '',
-//   add(str: string): void {
-//     this.value += str;
-//   },
-//   reset(): void {
-//     this.value = '';
-//   },
-// };

test/cli-formatters/custom-formatter.test.ts

@@ -0,0 +1,24 @@
+import test from 'ava';
+import { StringBuilder } from '../../src/helpers/string';
+import { PipelineItem } from '../../src/types';
+import customFormatter from '../../src/reporters/cli-formatters/custom-formatter';
+import { customFormatterFixture } from '../fixture/custom-formatter.fixture';
+
+customFormatterFixture.forEach(({ format, discoveryItem, expected, message }) => {
+  test(`customFormatter should ${message}`, (t) => {
+    // arrange
+    const pipelineItem: PipelineItem = {
+      profilingInformation: {},
+      discoveryItem,
+    };
+
+    const stringBuilder = new StringBuilder();
+
+    // act
+    customFormatter(pipelineItem, format, stringBuilder);
+
+    // assert
+    const value = stringBuilder.getValue();
+    t.true(value.includes(expected));
+  });
+});

test/cli-formatters/only-outdated-formatter.test.ts

@@ -0,0 +1,55 @@
+import test from 'ava';
+import { StringBuilder } from '../../src/helpers/string';
+import { PipelineItem } from '../../src/types';
+import onlyOutdatedFormatter from '../../src/reporters/cli-formatters/only-outdated-formatter';
+import chalk from 'chalk';
+
+test('onlyOutdatedFormatter should not build a string if the versions match', (t) => {
+  // arrange
+  const pipelineItem: PipelineItem = {
+    profilingInformation: {},
+    discoveryItem: {
+      version: '2.4.0',
+      packageJson: {
+        version: '2.4.0',
+      },
+    },
+  };
+
+  const stringBuilder = new StringBuilder();
+
+  // act
+  onlyOutdatedFormatter(pipelineItem, stringBuilder);
+
+  // assert
+  t.is(stringBuilder.getValue(), '');
+});
+
+test('onlyOutdatedFormatter should build the formatted string if the versions mismatch', (t) => {
+  // arrange
+  const pipelineItem: PipelineItem = {
+    profilingInformation: {},
+    discoveryItem: {
+      nameWithoutPrefix: 'vf-box',
+      version: '2.3.1',
+      packageJson: {
+        version: '2.4.0',
+      },
+      config: {
+        title: 'Box',
+        label: 'Box',
+        status: 'live',
+      },
+    },
+  };
+
+  const stringBuilder = new StringBuilder();
+
+  // act
+  onlyOutdatedFormatter(pipelineItem, stringBuilder);
+
+  // assert
+  const value = stringBuilder.getValue();
+  t.true(value.includes(chalk.bold('vf-box (Box)')));
+  t.true(value.includes(`(${chalk.red('2.3.1')} -> ${chalk.green('2.4.0')})`));
+});

test/fixture/custom-formatter.fixture.ts

@@ -0,0 +1,55 @@
+import { PDiscoveryItem } from '../../src/types';
+
+export interface CustomFormatterFixtureItem {
+  message: string;
+  discoveryItem: PDiscoveryItem;
+  format: string;
+  expected: string;
+}
+
+export const customFormatterFixture: CustomFormatterFixtureItem[] = [
+  {
+    message: 'display name, used version, latest version, and status',
+    discoveryItem: {
+      nameWithoutPrefix: 'vf-box',
+      version: '2.4.0',
+      packageJson: {
+        version: '2.5.1',
+      },
+      config: {
+        label: 'Box',
+        status: 'live',
+        title: 'Box',
+      },
+    },
+    format: '%name (%usedVersion, %latestVersion, %status)',
+    expected: 'vf-box (2.4.0, 2.5.1, live)',
+  },
+  {
+    message: 'display name and dependents',
+    discoveryItem: {
+      nameWithoutPrefix: 'vf-box',
+      dependents: ['test.html', 'tmp.html'],
+    },
+    format: '%name\\n%dependents(- %dependent\\n)',
+    expected: 'vf-box\n- test.html\n- tmp.html',
+  },
+  {
+    message: 'display name and changelog',
+    discoveryItem: {
+      nameWithoutPrefix: 'vf-box',
+      changelog: [
+        {
+          version: '2.0.1',
+          changes: ['change1', 'change2'],
+        },
+        {
+          version: '2.0.0',
+          changes: ['change1', 'change2'],
+        },
+      ],
+    },
+    format: '%name\\n%changelog(%version\\n%changes(- %change\\n)\\n)',
+    expected: 'vf-box\n2.0.1\n- change1\n- change2\n\n2.0.0\n- change1\n- change2',
+  },
+];