testit-api-client 1.0.1 → 1.0.2

package/src/client.ts

@@ -1,183 +0,0 @@
-import axios, { AxiosInstance, AxiosResponse } from 'axios';
-import minimist from 'minimist';
-import {
-  Attachment,
-  Autotest,
-  AutotestPost,
-  AutotestPut,
-  AutotestQuery,
-  AutotestResultsForTestRun,
-  ClientConfig,
-  ClientConfigWithFile,
-  IClient,
-  TestRunGet,
-  TestRunPost,
-  WorkItemId,
-} from './types';
-import { existsSync, readFileSync } from 'fs';
-import FormData from 'form-data';
-import { basename } from 'path';
-import { validateConfig } from './validation';
-
-export class Client implements IClient {
-  private readonly axios: AxiosInstance;
-  private config: ClientConfig;
-
-  constructor(config: Partial<ClientConfigWithFile>) {
-    const { configFile, ...restConfig } = config;
-    let finalConfig = restConfig;
-    if (configFile) {
-      finalConfig = Client.mergeConfig(
-        finalConfig,
-        this.readConfigFile(configFile)
-      );
-    }
-    finalConfig = Client.mergeConfig(finalConfig, this.readEnvConfig());
-    finalConfig = Client.mergeConfig(finalConfig, this.readCliConfig());
-    this.config = validateConfig(finalConfig);
-    const baseURL = new URL('/api/v2', this.config.url).toString();
-    this.axios = axios.create({
-      baseURL,
-      headers: {
-        Authorization: `PrivateToken ${this.config.privateToken}`,
-      },
-    });
-  }
-
-  async checkConnection() {
-    try {
-      await axios.get(new URL('version.json', this.config.url).toString());
-    } catch (err) {
-      throw new Error('Cannot connect to TestIt');
-    }
-  }
-
-  // TODO: add query object
-  async getAutotest(query: AutotestQuery): Promise<Autotest[]> {
-    const params = new URLSearchParams();
-    Object.keys(query).forEach((key) => {
-      const value = query[key as keyof AutotestQuery];
-      if (value === undefined) {
-        return;
-      }
-      if (Array.isArray(value)) {
-        value.forEach((v) => params.append(key, v));
-      } else {
-        params.append(key, value.toString());
-      }
-    });
-    return this.axios
-      .get(`/autoTests?${params.toString()}`)
-      .then((res) => res.data);
-  }
-
-  async createAutotest(autotest: AutotestPost): Promise<Autotest> {
-    return this.axios.post('/autoTests', autotest).then((res) => res.data);
-  }
-
-  async updateAutotest(autotest: AutotestPut): Promise<void> {
-    return this.axios.put('/autoTests', autotest);
-  }
-
-  async linkToWorkItem(
-    autotestId: string,
-    workItem: WorkItemId
-  ): Promise<void> {
-    return this.axios.post(`/autoTests/${autotestId}/workItems`, workItem);
-  }
-
-  async createTestRun(testRun: TestRunPost): Promise<TestRunGet> {
-    return this.axios
-      .post('/testRuns', testRun)
-      .then((res) => res.data as TestRunGet);
-  }
-
-  async startTestRun(testRunId: string): Promise<void> {
-    return this.axios.post(`/testRuns/${testRunId}/start`);
-  }
-
-  async loadTestRunResults(
-    testRunId: string,
-    results: AutotestResultsForTestRun[]
-  ): Promise<string[]> {
-    return await this.axios
-      .post<AutotestResultsForTestRun[], AxiosResponse<string[]>>(
-        `/testRuns/${testRunId}/testResults`,
-        results
-      )
-      .then((res) => res.data);
-  }
-
-  async completeTestRun(testRunId: string): Promise<void> {
-    return this.axios.post(`/testRuns/${testRunId}/complete`);
-  }
-
-  getConfig(): ClientConfig {
-    return this.config;
-  }
-
-  async loadAttachment(filePath: string): Promise<Attachment> {
-    const form = new FormData();
-    form.append('file', readFileSync(filePath), basename(filePath));
-    return this.axios
-      .post<FormData, AxiosResponse<Attachment>>('/Attachments', form, {
-        headers: form.getHeaders(),
-      })
-      .then((res) => res.data);
-  }
-
-  private readCliConfig(): Partial<ClientConfig> {
-    const args = minimist(process.argv.slice(2));
-    let config = {};
-    if (args['testitConfig']) {
-      config = this.readConfigFile(args['testitConfig']);
-    }
-    return Client.mergeConfig(config, {
-      url: args['testitUrl'],
-      privateToken: args['testitPrivateToken'],
-      projectId: args['testitProjectId'],
-      configurationId: args['testitConfigurationId'],
-      testRunId: args['testitTestRunId'],
-    });
-  }
-
-  private readEnvConfig(): Partial<ClientConfig> {
-    let config = {};
-    if (process.env['TESTIT_CONFIG_FILE']) {
-      config = this.readConfigFile(process.env['TESTIT_CONFIG_FILE']);
-    }
-    return Client.mergeConfig(config, {
-      url: process.env['TESTIT_URL'],
-      privateToken: process.env['TESTIT_PRIVATE_TOKEN'],
-      projectId: process.env['TESTIT_PROJECT_ID'],
-      configurationId: process.env['TESTIT_CONFIGURATION_ID'],
-      testRunId: process.env['TESTIT_TEST_RUN_ID'],
-    });
-  }
-
-  private readConfigFile(path: string): Partial<ClientConfig> {
-    if (!existsSync(path)) {
-      throw new Error('Config file not found');
-    }
-    const config = JSON.parse(
-      readFileSync(path, { encoding: 'utf8' })
-    ) as Partial<ClientConfig>;
-    if (config.privateToken) {
-      console.warn('Private token is in config file, it is not secure');
-    }
-    return config;
-  }
-
-  static mergeConfig(
-    oldConfig: Partial<ClientConfig>,
-    newConfig: Partial<ClientConfig>
-  ): Partial<ClientConfig> {
-    return {
-      url: newConfig.url ?? oldConfig.url,
-      privateToken: newConfig.privateToken ?? oldConfig.privateToken,
-      projectId: newConfig.projectId ?? oldConfig.projectId,
-      configurationId: newConfig.configurationId ?? oldConfig.configurationId,
-      testRunId: newConfig.testRunId ?? oldConfig.testRunId,
-    };
-  }
-}

package/src/types/attachment.ts

@@ -1,15 +0,0 @@
-export interface AttachmentPut {
-  id: string;
-}
-
-export interface Attachment {
-  fileId: string;
-  type: string;
-  size: number;
-  name: string;
-  createDate?: string;
-  modifiedDate?: string;
-  createdById?: string;
-  modifiedById?: string;
-  id?: string;
-}

package/src/types/autotest.ts

@@ -1,102 +0,0 @@
-import { LabelPost, LabelShort } from './label';
-import { Link, LinkPost, LinkPut } from './link';
-import { AutotestStep } from './autotestStep';
-
-export interface AutotestPost {
-  globalId?: number;
-  isDeleted?: boolean;
-  id?: string;
-  createdDate?: string;
-  modifiedDate?: string;
-  createdById?: string;
-  modifiedById?: string;
-  mustBeApproved?: boolean;
-  externalId: string;
-  links?: LinkPost[];
-  projectId: string;
-  name: string;
-  namespace?: string;
-  classname?: string;
-  steps?: AutotestStep[];
-  setup?: AutotestStep[];
-  teardown?: AutotestStep[];
-  title?: string;
-  description?: string;
-  labels?: LabelPost[];
-}
-
-export interface AutotestPut {
-  id?: string;
-  externalId: string;
-  links?: LinkPost[];
-  projectId: string;
-  name: string;
-  namespace?: string;
-  classname?: string;
-  steps?: AutotestStep[];
-  setup?: AutotestStep[];
-  teardown?: AutotestStep[];
-  title?: string;
-  description?: string;
-  labels?: LabelPost[];
-}
-
-export interface Autotest {
-  globalId?: number;
-  isDeleted?: boolean;
-  id?: string;
-  createdDate?: string;
-  modifiedDate?: string;
-  createdById?: string;
-  modifiedById?: string;
-  mustBeApproved?: boolean;
-  externalId: string;
-  links?: LinkPut[];
-  projectId: string;
-  name: string;
-  namespace?: string;
-  classname?: string;
-  steps?: AutotestStep[];
-  setup?: AutotestStep[];
-  teardown?: AutotestStep[];
-  title?: string;
-  description?: string;
-  labels?: LabelPost[];
-}
-
-export interface AutotestGet {
-  externalId?: string;
-  links?: Link[];
-  projectId?: string;
-  name?: string;
-  namespace?: string;
-  classname?: string;
-  steps?: AutotestStep[];
-  setup?: AutotestStep[];
-  teardown: AutotestStep[];
-  global?: number;
-  createdDate?: string;
-  modifiedDate?: string;
-  createdById?: string;
-  modifiedById?: string;
-  labels?: LabelShort[];
-  id?: string;
-  isDeleted?: boolean;
-}
-
-export interface AutotestQuery {
-  projectId?: string;
-  externalId?: string;
-  globalId?: number;
-  namespace?: string;
-  isNamespaceNull?: boolean;
-  classname?: string;
-  isClassnameNull?: boolean;
-  isDeleted?: boolean;
-  labels?: string[];
-  skip?: number;
-  take?: number;
-  orderBy?: string;
-  searchField?: string;
-  searchValue?: string;
-}

package/src/types/autotestResults.ts

@@ -1,23 +0,0 @@
-import { AttachmentPut } from './attachment';
-import { LinkPost } from './link';
-import { OutcomeType } from './outcome';
-import { Parameters } from './parameters';
-import { AttachmentPutModelAutotestStepResults } from './stepResults';
-
-export interface AutotestResultsForTestRun {
-  configurationId: string;
-  links?: LinkPost[];
-  failureReasonName?: string;
-  autotestExternalId: string;
-  outcome: OutcomeType;
-  message?: string;
-  traces?: string;
-  startedOn?: string;
-  completeOn?: string;
-  duration?: number;
-  attachments?: AttachmentPut[];
-  parameters?: Parameters;
-  stepResults?: AttachmentPutModelAutotestStepResults[];
-  setupResults?: AttachmentPutModelAutotestStepResults[];
-  teardownResults?: AttachmentPutModelAutotestStepResults[];
-}

package/src/types/autotestStep.ts

@@ -1,5 +0,0 @@
-export interface AutotestStep {
-  title: string;
-  description?: string;
-  steps?: AutotestStep[];
-}

package/src/types/capabilities.ts

@@ -1 +0,0 @@
-export type Capabilities = Record<string, string>;

package/src/types/client.ts

@@ -1,29 +0,0 @@
-import {
-  Attachment,
-  Autotest,
-  AutotestPost,
-  AutotestPut,
-  AutotestQuery,
-  AutotestResultsForTestRun,
-  ClientConfig,
-  TestRunGet,
-  TestRunPost,
-  WorkItemId,
-} from '.';
-
-export interface IClient {
-  checkConnection(): Promise<void>;
-  getAutotest(query: AutotestQuery): Promise<Autotest[]>;
-  createAutotest(autotest: AutotestPost): Promise<Autotest>;
-  updateAutotest(autotest: AutotestPut): Promise<void>;
-  linkToWorkItem(autotestId: string, workItem: WorkItemId): Promise<void>;
-  createTestRun(testRun: TestRunPost): Promise<TestRunGet>;
-  startTestRun(testRunId: string): Promise<void>;
-  loadTestRunResults(
-    testRunId: string,
-    results: AutotestResultsForTestRun[]
-  ): Promise<string[]>;
-  completeTestRun(testRunId: string): Promise<void>;
-  getConfig(): ClientConfig;
-  loadAttachment(fileName: string): Promise<Attachment>;
-}

package/src/types/config.ts

@@ -1,11 +0,0 @@
-export interface ClientConfig {
-  url: string;
-  privateToken: string;
-  projectId: string;
-  configurationId: string;
-  testRunId?: string;
-}
-
-export interface ClientConfigWithFile extends ClientConfig {
-  configFile?: string;
-}

package/src/types/configuration.ts

@@ -1,17 +0,0 @@
-import { Capabilities } from './capabilities';
-
-export interface Configuration {
-  description?: string;
-  isActive?: boolean;
-  capabilities: Capabilities;
-  projectId?: string;
-  isDefault?: boolean;
-  name?: string;
-  createdDate?: string;
-  modifiedDate?: string;
-  createdById?: string;
-  modifiedById?: string;
-  globalId?: number;
-  id?: number;
-  isDeleted?: boolean;
-}

package/src/types/label.ts

@@ -1,8 +0,0 @@
-export interface LabelShort {
-  globalId?: number;
-  name: string;
-}
-
-export interface LabelPost {
-  name: string;
-}

package/src/types/link.ts

@@ -1,33 +0,0 @@
-export type LinkType =
-  | 'Related'
-  | 'BlockedBy'
-  | 'Defect'
-  | 'Issue'
-  | 'Requirement'
-  | 'Repository';
-
-export interface LinkPost {
-  title?: string;
-  url: string;
-  description?: string;
-  type?: LinkType;
-  hasInfo?: boolean;
-}
-
-export interface LinkPut {
-  id?: string;
-  title?: string;
-  url: string;
-  description?: string;
-  type?: LinkType;
-  hasInfo?: boolean;
-}
-
-export interface Link {
-  id?: string;
-  title?: string;
-  url: string;
-  description?: string;
-  type?: LinkType;
-  hasInfo?: boolean;
-}

package/src/types/outcome.ts

@@ -1,6 +0,0 @@
-export type OutcomeType =
-  | 'Passed'
-  | 'Failed'
-  | 'Pending'
-  | 'Blocked'
-  | 'Skipped';

package/src/types/parameters.ts

@@ -1 +0,0 @@
-export type Parameters = Record<string, string>;

package/src/types/properties.ts

@@ -1 +0,0 @@
-export type Properties = Record<string, string>;

package/src/types/stepResults.ts

@@ -1,15 +0,0 @@
-import { AttachmentPut } from './attachment';
-import { OutcomeType } from './outcome';
-import { Parameters } from './parameters';
-
-export interface AttachmentPutModelAutotestStepResults {
-  title?: string;
-  description?: string;
-  startedOn?: string;
-  completedOn?: string;
-  duration?: number;
-  outcome?: OutcomeType;
-  stepResults?: AttachmentPutModelAutotestStepResults[];
-  attachments?: AttachmentPut[];
-  parameters?: Parameters;
-}

package/src/types/testPoint.ts

@@ -1,9 +0,0 @@
-export interface TestPointShort {
-  testSuiteId?: string;
-  id?: string;
-  testerId?: string;
-  workItemId?: string;
-  configurationId?: string;
-  status?: string;
-  lastTestResultId?: string;
-}

package/src/types/testResult.ts

@@ -1,32 +0,0 @@
-import { Attachment } from './attachment';
-import { AutotestGet } from './autotest';
-import { Configuration } from './configuration';
-import { Link } from './link';
-import { OutcomeType } from './outcome';
-import { Parameters } from './parameters';
-import { Properties } from './properties';
-import { TestPointShort } from './testPoint';
-
-export interface TestResultGet {
-  configuration?: Configuration;
-  autotest?: AutotestGet;
-  is?: string;
-  configurationId?: string;
-  workItemVersionId?: string;
-  autotestId?: string;
-  message?: string;
-  traces?: string;
-  startedOn?: string;
-  completedOn?: string;
-  runByUserId?: string;
-  stoppedByUserId?: string;
-  testPointId?: string;
-  testPoint?: TestPointShort;
-  testRunId?: string;
-  outcome?: OutcomeType;
-  comment?: string;
-  links?: Link[];
-  attachments?: Attachment[];
-  parameters?: Parameters;
-  properties?: Properties;
-}

package/src/types/testRun.ts

@@ -1,27 +0,0 @@
-import { TestResultGet } from './testResult';
-
-export type TestRunStateType =
-  | 'NotStarted'
-  | 'InProgress'
-  | 'Stopped'
-  | 'Completed';
-
-export interface TestRunPost {
-  projectId: string;
-  name?: string;
-}
-
-export interface TestRunGet {
-  startedOn?: string;
-  completedOn?: string;
-  stateName?: TestRunStateType;
-  projectId?: string;
-  testPlanId?: string;
-  testResults?: TestResultGet[];
-  createdDate?: string;
-  modifiedDate?: string;
-  createById?: string;
-  modifiedById?: string;
-  id: string;
-  name: string;
-}

package/src/validation.ts

@@ -1,14 +0,0 @@
-import { z } from 'zod';
-import { ClientConfig } from '.';
-
-const configSchema = z.object({
-  configurationId: z.string().uuid(),
-  privateToken: z.string(),
-  projectId: z.string().uuid(),
-  url: z.string().url(),
-  testRunId: z.string().uuid().optional(),
-});
-
-export function validateConfig(config: Partial<ClientConfig>): ClientConfig {
-  return configSchema.parse(config);
-}