311285953

Build Type

push

github

Committed by MarshalJoe

Commit Message

Pulls OAuth accessToken from session config and adds it to transaction object

Run Details

615 of 893 branches covered (68.87%)

Branch coverage included in aggregate %.

3 of 4 new or added lines in 1 file covered. (75.0%)

5 existing lines in 1 file now uncovered.

1746 of 2205 relevant lines covered (79.18%)

42.77 hits per line

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

64.44

/src/core/test-app/runner/suite.ts

import Test from "./test";
import { SdkApp } from "../../types";
import { TestsConfig } from "./config";
import { TransactionPOJO } from "@shipengine/connect-sdk/lib/internal";
import { log, logObject, indent } from "../../utils/log-helpers";
import { v4 } from "uuid";
import chalk from "chalk";

interface ConstructorArgs {
  app: SdkApp;
  options: any;
  staticConfigTests?: TestsConfig;
}

export default abstract class Suite {
  abstract title: string;

  protected app: SdkApp;

  protected _staticConfigTests?: TestsConfig;

  protected _rawStaticConfigTests: TestsConfig;

  protected options: any;

  constructor({ app, staticConfigTests, options }: ConstructorArgs) {
    this.app = app;
    this._rawStaticConfigTests = staticConfigTests || {};
    this.options = options;
  }

  get config(): TestsConfig {
    if (this._staticConfigTests) return this._staticConfigTests;

    const config: TestsConfig | undefined = Reflect.get(
      this._rawStaticConfigTests,
      this.title,
    );

    if (config) {
      this._staticConfigTests = config;
    } else {
      this._staticConfigTests = {};
    }

    return this._staticConfigTests;
  }

  abstract tests(): Test[];

  protected test(title: string, methodArgs: any, config: any, fn: any): Test {
    const testConfig = {
      debug:
        this.options.cli.debug ||
        config.debug ||
        this.options.staticRootConfig.debug ||
        this.options.defaults.debug,
      expectedErrorMessage: config.expectedErrorMessage,
      retries:
        this.options.cli.retries ||
        config.retries ||
        this.options.staticRootConfig.retries ||
        this.options.defaults.retries,
      skip: config.skip,
      timeout:
        this.options.cli.timeout ||
        config.timeout ||
        this.options.staticRootConfig.timeout ||
        this.options.defaults.timeout,
    };

    return { title, fn, methodArgs, ...testConfig };
  }

  protected async transaction(config: any): Promise<TransactionPOJO> {
    const testConfig = {
      debug:
        this.options.cli.debug ||
        config.debug ||
        this.options.staticRootConfig.debug ||
        this.options.defaults.debug,
      expectedErrorMessage: config.expectedErrorMessage,
      retries:
        this.options.cli.retries ||
        config.retries ||
        this.options.staticRootConfig.retries ||
        this.options.defaults.retries,
      skip: config.skip,
      timeout:
        this.options.cli.timeout ||
        config.timeout ||
        this.options.staticRootConfig.timeout ||
        this.options.defaults.timeout,
    };

    if (
      !config.connectArgs &&
      (config.session || this.options.staticRootConfig.session)
    ) {
      const transaction: TransactionPOJO = {
        id: v4(),
        session: config.session || this.options.staticRootConfig.session,
      };

      if (testConfig.debug) {
        log(
          chalk.yellow(
            `${indent(2)}using the session provided in connect.config.js`,
          ),
        );
        logObject(transaction);
      }

      return transaction;
    }

    if (config.connectArgs || this.options.staticRootConfig.connectArgs) {
      if (testConfig.debug) {
        log(
          chalk.yellow(
            `${indent(
              2,
            )}calling the connect method to set the session for the transaction with the connectArgs given in connect.config.js`,
          ),
        );
        logObject(
          config.connectArgs || this.options.staticRootConfig.connectArgs,
        );
      }

      const transaction: TransactionPOJO = {
        id: v4(),
        session: {},
      };

      // const retries = 0;
      // TODO - handle retry and timeout logic here
      // test.retries
      // test.timeout
      // Note if the app is definitions only we should have exited before we got here
      await this.app.connect!(
        transaction,
        config.connectArgs || this.options.staticRootConfig.connectArgs,
      );

      if (testConfig.debug) {
        log(chalk.green(`${indent(2)}the connect method ran successfully`));
        logObject(transaction);
      }

      return transaction;
    }

    const transaction: TransactionPOJO = {
      id: v4(),
      session: {},
    };

    if (testConfig.debug) {
      log(
        chalk.yellow(
          `${indent(
            2,
          )}connectArgs are not defined in connect.config.js the session value will be an empty object `,
        ),
      );
      logObject(transaction);
    }

    return transaction;
  }
}

1	import Test from "./test";
2	import { SdkApp } from "../../types";
3	import { TestsConfig } from "./config";
4	import { TransactionPOJO } from "@shipengine/connect-sdk/lib/internal";
5	import { log, logObject, indent } from "../../utils/log-helpers";	2✔
6	import { v4 } from "uuid";	2✔
7	import chalk from "chalk";	2✔
8
9	interface ConstructorArgs {
10	app: SdkApp;
11	options: any;
12	staticConfigTests?: TestsConfig;
13	}
14
15	export default abstract class Suite {	2✔
16	abstract title: string;
17
18	protected app: SdkApp;
19
20	protected _staticConfigTests?: TestsConfig;
21
22	protected _rawStaticConfigTests: TestsConfig;
23
24	protected options: any;
25
26	constructor({ app, staticConfigTests, options }: ConstructorArgs) {
27	this.app = app;	208✔
28	this._rawStaticConfigTests = staticConfigTests \|\| {};	208!
29	this.options = options;	208✔
30	}
31
32	get config(): TestsConfig {
33	if (this._staticConfigTests) return this._staticConfigTests;	432✔
34
35	const config: TestsConfig \| undefined = Reflect.get(	207✔
36	this._rawStaticConfigTests,
37	this.title,
38	);
39
40	if (config) {	207✔
41	this._staticConfigTests = config;	188✔
42	} else {
43	this._staticConfigTests = {};	19✔
44	}
45
46	return this._staticConfigTests;	207✔
47	}
48
49	abstract tests(): Test[];
50
51	protected test(title: string, methodArgs: any, config: any, fn: any): Test {
52	const testConfig = {	191✔
53	debug:
54	this.options.cli.debug \|\|	760✔
55	config.debug \|\|
56	this.options.staticRootConfig.debug \|\|
57	this.options.defaults.debug,
58	expectedErrorMessage: config.expectedErrorMessage,
59	retries:
60	this.options.cli.retries \|\|	764✔
61	config.retries \|\|
62	this.options.staticRootConfig.retries \|\|
63	this.options.defaults.retries,
64	skip: config.skip,
65	timeout:
66	this.options.cli.timeout \|\|	764✔
67	config.timeout \|\|
68	this.options.staticRootConfig.timeout \|\|
69	this.options.defaults.timeout,
70	};
71
72	return { title, fn, methodArgs, ...testConfig };	191✔
73	}
74
75	protected async transaction(config: any): Promise<TransactionPOJO> {
76	const testConfig = {	13✔
77	debug:
78	this.options.cli.debug \|\|	52✔
79	config.debug \|\|
80	this.options.staticRootConfig.debug \|\|
81	this.options.defaults.debug,
82	expectedErrorMessage: config.expectedErrorMessage,
83	retries:
84	this.options.cli.retries \|\|	52✔
85	config.retries \|\|
86	this.options.staticRootConfig.retries \|\|
87	this.options.defaults.retries,
88	skip: config.skip,
89	timeout:
90	this.options.cli.timeout \|\|	52✔
91	config.timeout \|\|
92	this.options.staticRootConfig.timeout \|\|
93	this.options.defaults.timeout,
94	};
95
96	if (	13!
97	!config.connectArgs &&	39✔
98	(config.session \|\| this.options.staticRootConfig.session)
99	) {
100	const transaction: TransactionPOJO = {	×
101	id: v4(),
102	session: config.session \|\| this.options.staticRootConfig.session,	×
103	};
104
105	if (testConfig.debug) {	×
106	log(	×
107	chalk.yellow(
108	`${indent(2)}using the session provided in connect.config.js`,
109	),
110	);
111	logObject(transaction);	×
112	}
113
114	return transaction;	×
115	}
116
117	if (config.connectArgs \|\| this.options.staticRootConfig.connectArgs) {	13!
UNCOV 118	if (testConfig.debug) {	×
119	log(	×
120	chalk.yellow(
121	`${indent(
122	2,
123	)}calling the connect method to set the session for the transaction with the connectArgs given in connect.config.js`,
124	),
125	);
126	logObject(	×
127	config.connectArgs \|\| this.options.staticRootConfig.connectArgs,	×
128	);
129	}
130
UNCOV 131	const transaction: TransactionPOJO = {	×
132	id: v4(),
133	session: {},
134	};
135
136	// const retries = 0;
137	// TODO - handle retry and timeout logic here
138	// test.retries
139	// test.timeout
140	// Note if the app is definitions only we should have exited before we got here
UNCOV 141	await this.app.connect!(	×
142	transaction,
143	config.connectArgs \|\| this.options.staticRootConfig.connectArgs,	×
144	);
145
UNCOV 146	if (testConfig.debug) {	×
147	log(chalk.green(`${indent(2)}the connect method ran successfully`));	×
148	logObject(transaction);	×
149	}
150
UNCOV 151	return transaction;	×
152	}
153
154	const transaction: TransactionPOJO = {	13✔
155	id: v4(),
156	session: {},
157	};
158
159	if (testConfig.debug) {	13!
160	log(	×
161	chalk.yellow(
162	`${indent(
163	2,
164	)}connectArgs are not defined in connect.config.js the session value will be an empty object `,
165	),
166	);
167	logObject(transaction);	×
168	}
169
170	return transaction;	13✔
171	}
172	}

ShipEngine / connect-cli / 311285953

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