@pipedream/testmo 0.1.0 → 0.3.0

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The Testmo API enables automation and integration of your testing workflows into the broader CI/CD pipeline. With Pipedream, you can use this API to trigger tests, update test cases, log results, and sync status with other project management tools. By creating custom serverless workflows on Pipedream, you can connect Testmo to various apps, manage test lifecycles, and respond to events from other services in real-time.
+
+# Example Use Cases
+
+- **Trigger Test Runs After Code Commits**: When a new commit is pushed to a repository in GitHub, use a Pipedream workflow to automatically trigger a series of test cases in Testmo. This ensures that new code is tested immediately, keeping your deployment pipeline efficient.
+
+- **Sync Test Results with Project Management Tools**: After tests are completed in Testmo, send the results to a project management tool like Jira or Asana. Use a Pipedream workflow to create or update issues based on the test outcomes, keeping your team in sync with the latest testing status.
+
+- **Aggregate Test Reports for Analytics**: Collect test results from Testmo and send them to a data visualization tool like Google Sheets or Data Studio. With a Pipedream workflow, you can create custom dashboards or reports that provide insights into your testing process and help identify areas for improvement.

package/actions/append-to-automation-run/append-to-automation-run.mjs

@@ -0,0 +1,104 @@
+import testmo from "../../testmo.app.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  key: "testmo-append-to-automation-run",
+  name: "Append to Automation Run",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  description: "Appends test artifacts, fields or links to an existing automation run. [See the documentation](https://docs.testmo.com/api/reference/automation-runs#post-automation-runs-automation_run_id-append)",
+  type: "action",
+  props: {
+    testmo,
+    projectId: {
+      propDefinition: [
+        testmo,
+        "projectId",
+      ],
+    },
+    automationRunId: {
+      propDefinition: [
+        testmo,
+        "automationRunId",
+        (c) => ({
+          projectId: c.projectId,
+        }),
+      ],
+    },
+    artifacts: {
+      propDefinition: [
+        testmo,
+        "artifacts",
+      ],
+    },
+    links: {
+      type: "string[]",
+      label: "Links",
+      description: "List of links to attach to the automation run (such as a link back to the build in the CI tool that triggered the tests).",
+      optional: true,
+    },
+    numFields: {
+      type: "integer",
+      label: "Number of Fields",
+      description: "Number of fields to enter name, type, and value for",
+      optional: true,
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    const props = {};
+    for (let i = 1; i <= this.numFields; i++) {
+      props[`name_${i}`] = {
+        type: "string",
+        label: `Field ${i} - Name`,
+      };
+      props[`type_${i}`] = {
+        type: "integer",
+        label: `Field ${i} - Type`,
+        options: constants.FIELD_TYPES,
+      };
+      props[`value_${i}`] = {
+        type: "string",
+        label: `Field ${i} - Value`,
+        optional: true,
+      };
+    }
+    return props;
+  },
+  async run({ $ }) {
+    const artifacts = this.artifacts?.map((artifact) => ({
+      name: artifact,
+      url: artifact,
+    }));
+    const links = this.links?.map((link) => ({
+      name: link,
+      url: link,
+    }));
+    const fields = [];
+    for (let i = 1; i <= this.numFields; i++) {
+      fields.push({
+        name: this[`name_${i}`],
+        type: this[`type_${i}`],
+        value: this[`value_${i}`],
+      });
+    }
+
+    const response = await this.testmo.appendToAutomationRun({
+      automationRunId: this.automationRunId,
+      data: {
+        artifacts,
+        links,
+        fields,
+      },
+      $,
+    });
+
+    $.export("$summary", `Successfully appended data to automation run with ID ${this.automationRunId}.`);
+
+    return response;
+  },
+};

package/actions/append-to-thread/append-to-thread.mjs

@@ -0,0 +1,152 @@
+import testmo from "../../testmo.app.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  key: "testmo-append-to-thread",
+  name: "Append to Thread in Automation Run",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  description: "Appends test artifacts, fields or test results to an existing thread in an automation run. [See the documentation](https://docs.testmo.com/api/reference/automation-runs#post-automation-runs-threads-automation_run_thread_id-append)",
+  type: "action",
+  props: {
+    testmo,
+    projectId: {
+      propDefinition: [
+        testmo,
+        "projectId",
+      ],
+    },
+    automationRunId: {
+      propDefinition: [
+        testmo,
+        "automationRunId",
+        (c) => ({
+          projectId: c.projectId,
+        }),
+      ],
+    },
+    threadId: {
+      propDefinition: [
+        testmo,
+        "threadId",
+        (c) => ({
+          automationRunId: c.automationRunId,
+        }),
+      ],
+    },
+    elapsedObserved: {
+      type: "integer",
+      label: "Elapsed Observed",
+      description: "Partial observed elapsed (execution time) in microseconds to add to the overall observed time of the thread.",
+      optional: true,
+    },
+    artifacts: {
+      propDefinition: [
+        testmo,
+        "artifacts",
+      ],
+    },
+    numFields: {
+      type: "integer",
+      label: "Number of Fields",
+      description: "Number of fields to append",
+      optional: true,
+      reloadProps: true,
+    },
+    numTests: {
+      type: "integer",
+      label: "Number of Tests",
+      description: "Number of tests to append",
+      optional: true,
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    const props = {};
+    if (this.numFields) {
+      for (let i = 1; i <= this.numFields; i++) {
+        props[`fieldName_${i}`] = {
+          type: "string",
+          label: `Field ${i} - Name`,
+        };
+        props[`type_${i}`] = {
+          type: "integer",
+          label: `Field ${i} - Type`,
+          options: constants.FIELD_TYPES,
+        };
+        props[`value_${i}`] = {
+          type: "string",
+          label: `Field ${i} - Value`,
+          optional: true,
+        };
+      }
+    }
+    if (this.numTests) {
+      for (let i = 1; i <= this.numTests; i++) {
+        props[`key_${i}`] = {
+          type: "string",
+          label: `Test ${i} - Key`,
+          description: "Key used to identify tests across multiple automation runs (in the context of the same source)",
+        };
+        props[`testName_${i}`] = {
+          type: "string",
+          label: `Test ${i} - Name`,
+          description: "Name of the test",
+        };
+        props[`status_${i}`] = {
+          type: "string",
+          label: `Test ${i} - Status`,
+          description: "Alias of the status for the result of the test (for example, `failed` or `passed`). The status aliases can be configured in Testmo's admin area.",
+        };
+        props[`folder_${i}`] = {
+          type: "string",
+          label: `Test ${i} - Folder`,
+          description: "Fully qualified name of the target folder of the test. Folders can be used to group related tests and usually map to class or type names as defined in the test automation suite",
+        };
+      }
+    }
+    return props;
+  },
+  async run({ $ }) {
+    const artifacts = this.artifacts?.map((artifact) => ({
+      name: artifact,
+      url: artifact,
+    }));
+    const fields = [];
+    for (let i = 1; i <= this.numFields; i++) {
+      fields.push({
+        name: this[`fieldName_${i}`],
+        type: this[`type_${i}`],
+        value: this[`value_${i}`],
+      });
+    }
+    const tests = [];
+    for (let i = 1; i <= this.numTests; i++) {
+      tests.push({
+        key: this[`key_${i}`],
+        name: this[`testName_${i}`],
+        status: this[`status_${i}`],
+        folder: this[`folder_${i}`],
+      });
+    }
+
+    const response = await this.testmo.appendToThread({
+      threadId: this.threadId,
+      data: {
+        elapsed_observed: this.elapsedObserved,
+        artifacts,
+        fields,
+        tests,
+      },
+      $,
+    });
+
+    $.export("$summary", `Successfully appended data to automation run thread with ID ${this.threadId}.`);
+
+    return response;
+  },
+};

package/actions/create-automation-run/create-automation-run.mjs

@@ -4,7 +4,12 @@ import testmo from "../../testmo.app.mjs";
 export default {
   key: "testmo-create-automation-run",
   name: "Create Automation Run",
-  version: "0.0.1",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   description: "Creates a new automation run in a target project in preparation for adding threads and test results. [See the documentation](https://docs.testmo.com/api/reference/automation-runs#post-projects-project_id-automation-runs)",
   type: "action",
   props: {

package/actions/list-automation-runs/list-automation-runs.mjs

@@ -3,7 +3,12 @@ import testmo from "../../testmo.app.mjs";
 export default {
   key: "testmo-list-automation-runs",
   name: "List Automation Runs",
-  version: "0.0.1",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   description: "List all automation runs for a project. [See the documentation](https://docs.testmo.com/api/reference/automation-runs#get-projects-project_id-automation-runs)",
   type: "action",
   props: {

package/actions/list-project-id-options/list-project-id-options.mjs

@@ -0,0 +1,33 @@
+import testmo from "../../testmo.app.mjs";
+
+export default {
+  key: "testmo-list-project-id-options",
+  name: "List Project ID Options",
+  description: "Retrieves available options for the Project ID field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    testmo,
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page of results to retrieve.",
+      min: 0,
+      default: 0,
+    },
+  },
+  async run({ $ }) {
+    const options = await testmo.propDefinitions.projectId.options.call(this.testmo, {
+      page: this.page,
+    });
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

package/actions/list-project-sessions/list-project-sessions.mjs

@@ -0,0 +1,46 @@
+import testmo from "../../testmo.app.mjs";
+
+export default {
+  key: "testmo-list-project-sessions",
+  name: "List Project Sessions",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  description: "List all sessions for a project. [See the documentation](https://docs.testmo.com/api/reference/sessions#get-projects-project_id-sessions)",
+  type: "action",
+  props: {
+    testmo,
+    projectId: {
+      propDefinition: [
+        testmo,
+        "projectId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      testmo,
+      projectId,
+    } = this;
+
+    const items = testmo.paginate({
+      fn: testmo.listSessions,
+      projectId,
+    });
+
+    const responseArray = [];
+
+    for await (const item of items) {
+      responseArray.push(item);
+    }
+
+    $.export("$summary", `${responseArray.length} session${responseArray.length === 1
+      ? " was"
+      : "s were"} successfully retrieved!`);
+
+    return responseArray;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,26 @@
+const FIELD_TYPES = [
+  {
+    value: 1,
+    label: "Regular string",
+  },
+  {
+    value: 2,
+    label: "Plain text",
+  },
+  {
+    value: 3,
+    label: "HTML text",
+  },
+  {
+    value: 4,
+    label: "Text to display in a terminal/console frame (with a monospaced font)",
+  },
+  {
+    value: 5,
+    label: "URL",
+  },
+];
+
+export default {
+  FIELD_TYPES,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/testmo",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Pipedream Testmo Components",
   "main": "testmo.app.mjs",
   "keywords": [
@@ -13,6 +13,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.5.1"
+    "@pipedream/platform": "^1.6.8"
   }
 }

package/testmo.app.mjs

@@ -62,6 +62,53 @@ export default {
         return result.map(({ name }) => name);
       },
     },
+    automationRunId: {
+      type: "string",
+      label: "Automation Run Id",
+      description: "The Id of the automation run.",
+      async options({
+        projectId, page,
+      }) {
+        const { result } = await this.listAutomationRuns({
+          projectId,
+          params: {
+            page: page + 1,
+          },
+        });
+
+        return result.map(({
+          id: value, name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+    threadId: {
+      type: "string",
+      label: "Thread Id",
+      description: "The Id of the thread of the automation run.",
+      async options({ automationRunId }) {
+        const { result } = await this.getAutomationRun({
+          automationRunId,
+        });
+        if (!result || !result?.threads) {
+          return;
+        }
+        return result.threads.map(({
+          id: value, name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+    artifacts: {
+      type: "string[]",
+      label: "Artifacts",
+      description: "List of URLs of externally stored test artifacts to link to the thread (such as log files, screenshots or test data)",
+      optional: true,
+    },
   },
   methods: {
     _apiUrl() {
@@ -122,6 +169,40 @@ export default {
         ...args,
       });
     },
+    getAutomationRun({
+      automationRunId, ...args
+    }) {
+      return this._makeRequest({
+        path: `automation/runs/${automationRunId}`,
+        ...args,
+      });
+    },
+    listSessions({
+      projectId, ...args
+    }) {
+      return this._makeRequest({
+        path: `projects/${projectId}/sessions`,
+        ...args,
+      });
+    },
+    appendToAutomationRun({
+      automationRunId, ...args
+    }) {
+      return this._makeRequest({
+        method: "POST",
+        path: `automation/runs/${automationRunId}/append`,
+        ...args,
+      });
+    },
+    appendToThread({
+      threadId, ...args
+    }) {
+      return this._makeRequest({
+        method: "POST",
+        path: `automation/runs/threads/${threadId}/append`,
+        ...args,
+      });
+    },
     async *paginate({
       fn, params = {}, maxResults = null, ...args
     }) {