Initial test framework

Add Jest test framework

Signed-off-by: James Taylor <jamest@uk.ibm.com>

asset-transfer-basic/rest-api-typescript/jest.config.ts

@@ -0,0 +1,192 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+export default {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/04/rqvxpdk52gvf1_qq9l8gt4d40000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: 'coverage',
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: 'v8',
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  preset: 'ts-jest',
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  roots: ['<rootDir>/src'],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: [
+    //   "**/__tests__/**/*.[jt]s?(x)",
+    '**/?(*.)+(spec|test).[tj]s?(x)',
+  ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

asset-transfer-basic/rest-api-typescript/package.json

@@ -21,19 +21,25 @@
   "devDependencies": {
     "@types/express": "^4.17.12",
     "@types/ioredis": "^4.26.4",
+    "@types/jest": "^26.0.24",
     "@types/node": "^15.12.4",
     "@types/passport": "^1.0.7",
     "@types/pino": "^6.3.8",
     "@types/pino-http": "^5.4.1",
+    "@types/supertest": "^2.0.11",
     "@typescript-eslint/eslint-plugin": "^4.28.0",
     "@typescript-eslint/parser": "^4.28.0",
     "eslint": "^7.29.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^3.4.0",
+    "jest": "^27.0.6",
     "pino-pretty": "^5.0.2",
     "prettier": "^2.3.1",
     "rimraf": "^3.0.2",
-    "typescript": "^4.3.4"
+    "supertest": "^6.1.4",
+    "ts-jest": "^27.0.4",
+    "ts-node": "^10.1.0",
+    "typescript": "^4.3.5"
   },
   "scripts": {
     "prebuild": "npm run lint",
@@ -45,7 +51,7 @@
     "start": "node --require source-map-support/register ./dist",
     "start:dev": "node --require source-map-support/register --require dotenv/config ./dist | pino-pretty",
     "start:redis": "docker run -p 6379:6379 --name fabric-sample-redis -d redis",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest"
   },
   "author": "Hyperledger",
   "license": "Apache-2.0",

asset-transfer-basic/rest-api-typescript/src/__mocks__/config.ts

@@ -0,0 +1,55 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export const logLevel = 'info';
+
+export const port = '3000';
+
+export const retryDelay = '3000';
+
+export const asLocalHost = true;
+
+export const identityNameOrg1 = 'Org1';
+
+export const identityNameOrg2 = 'Org2';
+
+export const mspIdOrg1 = 'Org1MSP';
+
+export const mspIdOrg2 = 'Org2MSP';
+
+export const channelName = 'mychannel';
+
+export const chaincodeName = 'basic';
+
+export const commitTimeout = '3000';
+
+export const endorseTimeout = '30';
+
+export const connectionProfileOrg1 = '{"name":"mock-profile-org1"}';
+
+export const certificateOrg1 =
+  '"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n"';
+
+export const privateKeyOrg1 =
+  '"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n"';
+
+export const connectionProfileOrg2 = '{"name":"mock-profile-org2"}';
+
+export const certificateOrg2 =
+  '"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n"';
+
+export const privateKeyOrg2 =
+  '"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n"';
+
+export const redisHost = 'localhost';
+
+export const redisPort = '6379';
+
+export const redisUsername = 'conga';
+
+export const redisPassword = '';
+
+export const org1ApiKey = '123';
+
+export const org2ApiKey = '456';

asset-transfer-basic/rest-api-typescript/src/__mocks__/fabric-network.ts

@@ -0,0 +1,41 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { mocked } from 'ts-jest/utils';
+
+type FabricNetworkModule = jest.Mocked<typeof import('fabric-network')>;
+
+const {
+  DefaultEventHandlerStrategies,
+  DefaultQueryHandlerStrategies,
+  Gateway,
+  Wallet,
+  Wallets,
+}: FabricNetworkModule = jest.createMockFromModule('fabric-network');
+
+mocked(Wallets.newInMemoryWallet).mockResolvedValue(
+  new Wallet({
+    get: jest.fn(),
+    list: jest.fn(),
+    put: jest.fn(),
+    remove: jest.fn(),
+  })
+);
+
+mocked(Gateway.prototype.getNetwork).mockResolvedValue({
+  getGateway: jest.fn(),
+  getContract: jest.fn(),
+  getChannel: jest.fn(),
+  addCommitListener: jest.fn(),
+  removeCommitListener: jest.fn(),
+  addBlockListener: jest.fn(),
+  removeBlockListener: jest.fn(),
+});
+
+export {
+  DefaultEventHandlerStrategies,
+  DefaultQueryHandlerStrategies,
+  Gateway,
+  Wallets,
+};

asset-transfer-basic/rest-api-typescript/src/__tests__/api.test.ts

@@ -0,0 +1,31 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { createServer } from '../server';
+import { Application } from 'express';
+import request from 'supertest';
+
+jest.mock('../config');
+jest.mock('fabric-network');
+jest.mock('ioredis');
+
+describe('Asset Transfer Besic REST API', () => {
+  let app: Application;
+
+  beforeEach(async () => {
+    app = await createServer();
+  });
+
+  describe('GET /ready', () => {
+    it('should respond with success json', async () => {
+      const response = await request(app).get('/ready');
+      expect(response.statusCode).toEqual(200);
+      expect(response.header).toHaveProperty(
+        'content-type',
+        'application/json; charset=utf-8'
+      );
+      expect(response.body.status).toEqual('OK');
+    });
+  });
+});

asset-transfer-basic/rest-api-typescript/src/config.ts

@@ -28,15 +28,16 @@ export const asLocalHost = env
   .asBoolStrict();
 
 export const identityNameOrg1 = 'Org1';
+
 export const identityNameOrg2 = 'Org2';
 
-const mspIdOrg1 = env
+export const mspIdOrg1 = env
   .get('HLF_MSP_ID_ORG1')
   .default('Org1MSP')
   .example('Org1MSP')
   .asString();
 
-const mspIdOrg2 = env
+export const mspIdOrg2 = env
   .get('HLF_MSP_ID_ORG2')
   .default('Org2MSP')
   .example('Org2MSP')
@@ -66,7 +67,7 @@ export const endorseTimeout = env
   .example('30')
   .asIntPositive();
 
-const connectionProfileOrg1 = env
+export const connectionProfileOrg1 = env
   .get('HLF_CONNECTION_PROFILE_ORG1')
   .required()
   .example(
@@ -74,19 +75,19 @@ const connectionProfileOrg1 = env
   )
   .asJsonObject();
 
-const certificateOrg1 = env
+export const certificateOrg1 = env
   .get('HLF_CERTIFICATE_ORG1')
   .required()
   .example('"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n"')
   .asString();
 
-const privateKeyOrg1 = env
+export const privateKeyOrg1 = env
   .get('HLF_PRIVATE_KEY_ORG1')
   .required()
   .example('"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n"')
   .asString();
 
-const connectionProfileOrg2 = env
+export const connectionProfileOrg2 = env
   .get('HLF_CONNECTION_PROFILE_ORG2')
   .required()
   .example(
@@ -94,13 +95,13 @@ const connectionProfileOrg2 = env
   )
   .asJsonObject();
 
-const certificateOrg2 = env
+export const certificateOrg2 = env
   .get('HLF_CERTIFICATE_ORG2')
   .required()
   .example('"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n"')
   .asString();
 
-const privateKeyOrg2 = env
+export const privateKeyOrg2 = env
   .get('HLF_PRIVATE_KEY_ORG2')
   .required()
   .example('"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n"')
@@ -136,19 +137,3 @@ export const org2ApiKey = env
   .required()
   .example('456')
   .asString();
-
-export const ORG1_CONFIG = {
-  identityName: identityNameOrg1,
-  mspId: mspIdOrg1,
-  connectionProfile: connectionProfileOrg1,
-  certificate: certificateOrg1,
-  privateKey: privateKeyOrg1,
-};
-
-export const ORG2_CONFIG = {
-  identityName: identityNameOrg2,
-  mspId: mspIdOrg2,
-  connectionProfile: connectionProfileOrg2,
-  certificate: certificateOrg2,
-  privateKey: privateKeyOrg2,
-};

asset-transfer-basic/rest-api-typescript/src/fabric.ts

@@ -40,9 +40,25 @@ interface FabricConfigType {
   privateKey: string;
 }
 
+const ORG1_CONFIG = {
+  identityName: config.identityNameOrg1,
+  mspId: config.mspIdOrg1,
+  connectionProfile: config.connectionProfileOrg1,
+  certificate: config.certificateOrg1,
+  privateKey: config.privateKeyOrg1,
+};
+
+const ORG2_CONFIG = {
+  identityName: config.identityNameOrg2,
+  mspId: config.mspIdOrg2,
+  connectionProfile: config.connectionProfileOrg2,
+  certificate: config.certificateOrg2,
+  privateKey: config.privateKeyOrg2,
+};
+
 const FabricDataMapper: { [key: string]: FabricConfigType } = {
-  [config.identityNameOrg1]: config.ORG1_CONFIG,
-  [config.identityNameOrg2]: config.ORG2_CONFIG,
+  [config.identityNameOrg1]: ORG1_CONFIG,
+  [config.identityNameOrg2]: ORG2_CONFIG,
 };
 
 export const getGateway = async (org: string): Promise<Gateway> => {

asset-transfer-basic/rest-api-typescript/src/server.ts

@@ -67,6 +67,10 @@ export const createServer = async (): Promise<Application> => {
     // TBC
   }
 
+  if (process.env.NODE_ENV === 'test') {
+    // TBC
+  }
+
   if (process.env.NODE_ENV === 'production') {
     app.use(helmet());
   }