296170480

Build Type

push

github

Committed by rkrauskopf

Commit Message

Merge branch 'master' into DX-235-Cancel-next-day-pickup

Run Details

578 of 842 branches covered (68.65%)

Branch coverage included in aggregate %.

119 of 129 new or added lines in 4 files covered. (92.25%)

1 existing line in 1 file now uncovered.

1626 of 2075 relevant lines covered (78.36%)

41.92 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

14.75

/src/core/test-app.ts

import Config from "./test-app/runner/config";
import Runner from "./test-app/runner";
import loadAndValidateApp, { isInvalidAppError } from "./load-and-validate-app";
import {
  CreateShipmentInternational,
  CreateShipmentDomestic,
  CreateShipmentWithInsurance,
  CreateShipmentMultiPackage,
  RateShipment,
  CreateShipmentReturn,
  TrackShipment, 
  CancelPickupsNextDay,
  TrackShipmentReturn,
  SameDayPickup,
  NextDayPickup,
  CancelPickupsSameDay,
  RateShipmentReturn,
  CancelShipment,
  RateShipmentWithAllServices
} from "./test-app/tests";
import { SdkApp } from "./types";
import { TestResults, useTestResults } from "./test-app/runner/test-results";
import { loadAndValidateConfig, LoadAndValidateConfigError } from "./test-app/runner/load-and-validate-config";
import { logFail, logPass, logStep } from "./utils/log-helpers";
import { logResults } from "./utils/log-helpers";

export const TestAppErrors = LoadAndValidateConfigError;

interface TestOptions {
  debug?: boolean;
  failFast?: boolean;
  grep?: string;
  retries?: number;
  timeout?: number;
}

export default async function testApp(
  pathToApp: string,
  { debug, failFast, grep, retries, timeout }: TestOptions,
): Promise<TestResults> {
  const [testResults, testResultsReducer] = useTestResults();

  // Set NODE_ENV first because its possible that the shipengine.config
  // might key off the process.env to set environment variables
  process.env.NODE_ENV = "test";

  let staticConfig: Config = {};

  try {
    staticConfig = await loadAndValidateConfig(pathToApp);
  } catch (error) {
    switch (error.code) {
      case LoadAndValidateConfigError.SchemaInvalid:
      case LoadAndValidateConfigError.Syntax:
        throw error;
      default:
        // IF the file doesnt exist an error will be thrown and we want to swallow that here
        break;
    }
  }

  let app: SdkApp;

  try {
    logStep("validating app structure");

    app = await loadAndValidateApp(pathToApp);

    logPass("app structure is valid");
    testResultsReducer("INCREMENT_PASSED");
  } catch (error) {

    if (isInvalidAppError(error)) {
      const errorsCount = error.errors.length;
      const errorsWithInflection = errorsCount > 1 ? "errors" : "error";

      logFail(
        `App structure is not valid - ${errorsCount} ${errorsWithInflection} found`,
      );

      error.errors.forEach((errorMessage: string) => {
        logFail(errorMessage);
      });

      for (let i = 0; i < errorsCount; i++) {
        testResultsReducer("INCREMENT_FAILED");
      }

      logResults(testResults);
      return testResults;
    }

    throw error;
  }

  const options = {
    defaults: {
      connectArgs: {},
      debug: false,
      failFast: false,
      retries: 0,
      session: {},
      timeout: 2000,
    },
    staticRootConfig: {
      connectArgs: staticConfig.connectArgs,
      debug: staticConfig.debug,
      failFast: staticConfig.failFast,
      retries: staticConfig.retries,
      session: staticConfig.session,
      timeout: staticConfig.timeout,
    },
    cli: {
      debug,
      failFast,
      retries,
      timeout,
    },
    failFast(): boolean {
      return (
        this.cli.failFast ||
        this.staticRootConfig.failFast ||
        this.defaults.failFast
      );
    },
  };

  const registeredTestSuiteModules = registerTestSuiteModules(app);

  const suites = registeredTestSuiteModules.map(
    (suite: any) =>
      new suite({
        app,
        staticConfigTests: staticConfig.tests,
        options: options,
      }),
  );

  await new Runner({
    failFast: options.failFast(),
    grep: grep,
    suites,
    testResults,
    testResultsReducer,
  }).run();

  logResults(testResults);

  return testResults;
}

type RegisteredTestSuiteModules = object[];

function registerTestSuiteModules(app: SdkApp): RegisteredTestSuiteModules {
  const carrierAppMethods = {
    // cancelPickups: [CancelPickupsTestSuite],
    cancelShipments: [CancelShipment],
    // createManifest: [CreateManifestTestSuite],
    createShipment: [
      CreateShipmentInternational,
      CreateShipmentDomestic,
      CreateShipmentMultiPackage,
      CreateShipmentWithInsurance,
      CreateShipmentReturn
    ],
    cancelPickups: [CancelPickupsSameDay, CancelPickupsNextDay],
    schedulePickup: [SameDayPickup, NextDayPickup],
    rateShipment: [
      RateShipment,
      RateShipmentWithAllServices,
      RateShipmentReturn
    ],
    trackShipment: [TrackShipment, TrackShipmentReturn],
  };

  const orderAppMethods = {
    // getSalesOrdersByDate: [GetSalesOrdersByDateTestSuite],
    // shipmentCancelled: [ShipmentCancelledTestSuite],
    // shipmentCreated: [ShipmentCreatedTestSuite],
  };

  const allMethods = { ...carrierAppMethods, ...orderAppMethods };

  let registeredTestSuiteModules: RegisteredTestSuiteModules = [];

  for (const method in allMethods) {
    if (Reflect.get(app, method)) {
      registeredTestSuiteModules = registeredTestSuiteModules.concat(
        Reflect.get(allMethods, method),
      );
    }
  }

  return registeredTestSuiteModules;
}

1	import Config from "./test-app/runner/config";
2	import Runner from "./test-app/runner";	1✔
3	import loadAndValidateApp, { isInvalidAppError } from "./load-and-validate-app";	1✔
4	import {	1✔
5	CreateShipmentInternational,
6	CreateShipmentDomestic,
7	CreateShipmentWithInsurance,
8	CreateShipmentMultiPackage,
9	RateShipment,
10	CreateShipmentReturn,
11	TrackShipment,
12	CancelPickupsNextDay,
13	TrackShipmentReturn,
14	SameDayPickup,
15	NextDayPickup,
16	CancelPickupsSameDay,
17	RateShipmentReturn,
18	CancelShipment,
19	RateShipmentWithAllServices
20	} from "./test-app/tests";
21	import { SdkApp } from "./types";
22	import { TestResults, useTestResults } from "./test-app/runner/test-results";	1✔
23	import { loadAndValidateConfig, LoadAndValidateConfigError } from "./test-app/runner/load-and-validate-config";	1✔
24	import { logFail, logPass, logStep } from "./utils/log-helpers";	1✔
25	import { logResults } from "./utils/log-helpers";	1✔
26
27	export const TestAppErrors = LoadAndValidateConfigError;	1✔
28
29	interface TestOptions {
30	debug?: boolean;
31	failFast?: boolean;
32	grep?: string;
33	retries?: number;
34	timeout?: number;
35	}
36
37	export default async function testApp(	1✔
38	pathToApp: string,
39	{ debug, failFast, grep, retries, timeout }: TestOptions,
40	): Promise<TestResults> {
41	const [testResults, testResultsReducer] = useTestResults();	×
42
43	// Set NODE_ENV first because its possible that the shipengine.config
44	// might key off the process.env to set environment variables
45	process.env.NODE_ENV = "test";	×
46
47	let staticConfig: Config = {};	×
48
49	try {	×
50	staticConfig = await loadAndValidateConfig(pathToApp);	×
51	} catch (error) {
52	switch (error.code) {	×
53	case LoadAndValidateConfigError.SchemaInvalid:	×
54	case LoadAndValidateConfigError.Syntax:
UNCOV 55	throw error;	×
56	default:
57	// IF the file doesnt exist an error will be thrown and we want to swallow that here
58	break;	×
59	}
60	}
61
62	let app: SdkApp;
63
64	try {	×
65	logStep("validating app structure");	×
66
67	app = await loadAndValidateApp(pathToApp);	×
68
69	logPass("app structure is valid");	×
70	testResultsReducer("INCREMENT_PASSED");	×
71	} catch (error) {
72
73	if (isInvalidAppError(error)) {	×
74	const errorsCount = error.errors.length;	×
75	const errorsWithInflection = errorsCount > 1 ? "errors" : "error";	×
76
77	logFail(	×
78	`App structure is not valid - ${errorsCount} ${errorsWithInflection} found`,
79	);
80
81	error.errors.forEach((errorMessage: string) => {	×
82	logFail(errorMessage);	×
83	});
84
85	for (let i = 0; i < errorsCount; i++) {	×
86	testResultsReducer("INCREMENT_FAILED");	×
87	}
88
89	logResults(testResults);	×
90	return testResults;	×
91	}
92
93	throw error;	×
94	}
95
96	const options = {	×
97	defaults: {
98	connectArgs: {},
99	debug: false,
100	failFast: false,
101	retries: 0,
102	session: {},
103	timeout: 2000,
104	},
105	staticRootConfig: {
106	connectArgs: staticConfig.connectArgs,
107	debug: staticConfig.debug,
108	failFast: staticConfig.failFast,
109	retries: staticConfig.retries,
110	session: staticConfig.session,
111	timeout: staticConfig.timeout,
112	},
113	cli: {
114	debug,
115	failFast,
116	retries,
117	timeout,
118	},
119	failFast(): boolean {
120	return (	×
121	this.cli.failFast \|\|	×
122	this.staticRootConfig.failFast \|\|
123	this.defaults.failFast
124	);
125	},
126	};
127
128	const registeredTestSuiteModules = registerTestSuiteModules(app);	×
129
130	const suites = registeredTestSuiteModules.map(	×
131	(suite: any) =>
132	new suite({	×
133	app,
134	staticConfigTests: staticConfig.tests,
135	options: options,
136	}),
137	);
138
139	await new Runner({	×
140	failFast: options.failFast(),
141	grep: grep,
142	suites,
143	testResults,
144	testResultsReducer,
145	}).run();
146
147	logResults(testResults);	×
148
149	return testResults;	×
150	}
151
152	type RegisteredTestSuiteModules = object[];
153
154	function registerTestSuiteModules(app: SdkApp): RegisteredTestSuiteModules {
155	const carrierAppMethods = {	×
156	// cancelPickups: [CancelPickupsTestSuite],
157	cancelShipments: [CancelShipment],
158	// createManifest: [CreateManifestTestSuite],
159	createShipment: [
160	CreateShipmentInternational,
161	CreateShipmentDomestic,
162	CreateShipmentMultiPackage,
163	CreateShipmentWithInsurance,
164	CreateShipmentReturn
165	],
166	cancelPickups: [CancelPickupsSameDay, CancelPickupsNextDay],
167	schedulePickup: [SameDayPickup, NextDayPickup],
168	rateShipment: [
169	RateShipment,
170	RateShipmentWithAllServices,
171	RateShipmentReturn
172	],
173	trackShipment: [TrackShipment, TrackShipmentReturn],
174	};
175
176	const orderAppMethods = {	×
177	// getSalesOrdersByDate: [GetSalesOrdersByDateTestSuite],
178	// shipmentCancelled: [ShipmentCancelledTestSuite],
179	// shipmentCreated: [ShipmentCreatedTestSuite],
180	};
181
182	const allMethods = { ...carrierAppMethods, ...orderAppMethods };	×
183
184	let registeredTestSuiteModules: RegisteredTestSuiteModules = [];	×
185
186	for (const method in allMethods) {	×
187	if (Reflect.get(app, method)) {	×
188	registeredTestSuiteModules = registeredTestSuiteModules.concat(	×
189	Reflect.get(allMethods, method),
190	);
191	}
192	}
193
194	return registeredTestSuiteModules;	×
195	}

ShipEngine / connect-cli / 296170480

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous