Create Requirement with PractiTest API on Changes to Specific Files from Google Drive API

Pipedream makes it easy to connect APIs for PractiTest, Google Drive and 2,900+ other apps remarkably fast.

Trigger workflow on

Changes to Specific Files from the Google Drive API

Next, do this

Create Requirement with the PractiTest API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Google Drive trigger and PractiTest action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Changes to Specific Files trigger
1. Configure infoAlert
2. Connect your Google Drive account
3. Optional- Configure Drive
4. Configure Push notification renewal schedule
5. Select one or more Files
6. Optional- Configure Include Link
7. Optional- Configure dir
8. Configure intervalAlert
9. Optional- Configure Minimum Interval Per File
10. Select one or more Types of updates
Configure the Create Requirement action
1. Connect your PractiTest account
2. Select a Project
3. Configure Name
4. Select a Author
5. Optional- Configure Description
6. Optional- Select a Assigned To
7. Optional- Configure Version
8. Optional- Configure Priority
9. Optional- Configure Custom Fields
10. Optional- Configure Parent ID
11. Optional- Configure Test IDs
12. Optional- Configure Tags
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

Changes to Specific Files on Google Drive

Description:Watches for changes to specific files, emitting an event when a change is made to one of those files. To watch for changes to [shared drive](https://support.google.com/a/users/answer/9310351) files, use the **Changes to Specific Files (Shared Drive)** source instead.

Version:0.3.1

Key:google_drive-changes-to-specific-files

View on GitHub

Google Drive Overview#

The Google Drive API on Pipedream allows you to automate various file management tasks, such as creating, reading, updating, and deleting files within your Google Drive. You can also share files, manage permissions, and monitor changes to files and folders. This opens up possibilities for creating workflows that seamlessly integrate with other apps and services, streamlining document handling, backup processes, and collaborative workflows.

Trigger Code#

import cronParser from "cron-parser";
import includes from "lodash/includes.js";
import { v4 as uuid } from "uuid";
import { MY_DRIVE_VALUE } from "../../common/constants.mjs";
import changesToSpecificFiles from "../changes-to-specific-files-shared-drive/changes-to-specific-files-shared-drive.mjs";
import { ConfigurationError } from "@pipedream/platform";
import sampleEmit from "./test-event.mjs";

/**
 * This source uses the Google Drive API's
 * {@link https://developers.google.com/drive/api/v3/reference/files/watch files: watch}
 * endpoint to subscribe to changes to specific files in the user's drive.
 */
export default {
  ...changesToSpecificFiles,
  key: "google_drive-changes-to-specific-files",
  name: "Changes to Specific Files",
  description: "Watches for changes to specific files, emitting an event when a change is made to one of those files. To watch for changes to [shared drive](https://support.google.com/a/users/answer/9310351) files, use the **Changes to Specific Files (Shared Drive)** source instead.",
  version: "0.3.1",
  type: "source",
  // Dedupe events based on the "x-goog-message-number" header for the target channel:
  // https://developers.google.com/drive/api/v3/push#making-watch-requests
  dedupe: "unique",
  props: {
    infoAlert: {
      type: "alert",
      alertType: "info",
      content: "This source uses `files.watch` and supports up to 10 file subscriptions. To watch for changes to more than 10 files, use the **Changes to Files in Drive** source instead (uses `changes.watch`).",
    },
    ...changesToSpecificFiles.props,
    drive: {
      type: "string",
      label: "Drive",
      description: "Defaults to `My Drive`. To use a [Shared Drive](https://support.google.com/a/users/answer/9310351), use the **Changes to Specific Files (Shared Drive)** source instead.",
      optional: true,
      default: MY_DRIVE_VALUE,
    },
    updateTypes: {
      propDefinition: [
        changesToSpecificFiles.props.googleDrive,
        "updateTypes",
      ],
    },
    includeLink: {
      label: "Include Link",
      type: "boolean",
      description: "Upload file to your File Stash and emit temporary download link to the file. Google Workspace documents will be converted to PDF. See [the docs](https://pipedream.com/docs/connect/components/files) to learn more about working with files in Pipedream.",
      default: false,
      optional: true,
    },
    dir: {
      type: "dir",
      accessMode: "write",
      optional: true,
    },
  },
  hooks: {
    ...changesToSpecificFiles.hooks,
    async deploy() {
      if (this.files.length > 10) {
        throw new ConfigurationError("This source only supports up to 10 files");
      }
      await changesToSpecificFiles.hooks.deploy.bind(this)();
    },
    async activate() {
      // Called when a component is created or updated. Handles all the logic
      // for starting and stopping watch notifications tied to the desired
      // files.

      // You can pass the same channel ID in watch requests for multiple files, so
      // our channel ID is fixed for this component to simplify the state we have to
      // keep track of.
      const channelID = uuid();

      // Subscriptions are keyed on Google's resourceID, "an opaque value that
      // identifies the watched resource". This value is included in request
      // headers, allowing us to look up the watched resource.
      let subscriptions = this._getSubscriptions() || {};

      const files = this.files;
      for (const fileID of files) {
        const {
          expiration,
          resourceId,
        } = await this.googleDrive.activateFileHook(
          channelID,
          this.http.endpoint,
          fileID,
        );
        // The fileID must be kept with the subscription metadata so we can
        // renew the watch request for this specific file when it expires.
        subscriptions[resourceId] = {
          expiration,
          fileID,
        };
      }

      // Save metadata on the subscription so we can stop / renew later
      this._setSubscriptions(subscriptions);
      this._setChannelID(channelID);
    },
    async deactivate() {
      const channelID = this._getChannelID();
      if (!channelID) {
        console.log(
          "Channel not found, cannot stop notifications for non-existent channel",
        );
        return;
      }

      const subscriptions = this._getSubscriptions() || {};
      for (const resourceId of Object.keys(subscriptions)) {
        await this.googleDrive.stopNotifications(channelID, resourceId);
      }

      // Reset DB state
      this._setSubscriptions({});
      this._setChannelID(null);
    },
  },
  methods: {
    ...changesToSpecificFiles.methods,
    _getSubscriptions() {
      return this.db.get("subscriptions") || {};
    },
    _setSubscriptions(subscriptions) {
      this.db.set("subscriptions", subscriptions);
    },
    _getNextTimerEventTimestamp(event) {
      if (event.cron) {
        return cronParser
          .parseExpression(event.cron)
          .next()
          .getTime();
      }
      if (event.interval_seconds) {
        return Date.now() + event.interval_seconds * 1000;
      }
    },
    async renewFileSubscriptions(event) {
      const subscriptions = this._getSubscriptions() || {};
      const channelID = this._getChannelID();
      const newChannelID = uuid();

      const nextRunTimestamp = this._getNextTimerEventTimestamp(event);

      for (const [
        currentResourceId,
        metadata,
      ] of Object.entries(subscriptions)) {
        const { fileID } = metadata;

        const subscription = {
          ...metadata,
          resourceId: currentResourceId,
        };
        const {
          expiration,
          resourceId,
        } = await this.googleDrive.renewFileSubscription(
          subscription,
          this.http.endpoint,
          channelID,
          newChannelID,
          fileID,
          nextRunTimestamp,
        );
        subscriptions[resourceId] = {
          expiration,
          fileID,
        };
      }
      this._setSubscriptions(subscriptions);
      this._setChannelID(newChannelID);
    },
  },
  async run(event) {
    // This function is polymorphic: it can be triggered as a cron job, to make sure we renew
    // watch requests for specific files, or via HTTP request (the change payloads from Google)

    // Component was invoked by timer
    if (event.timestamp) {
      return this.renewFileSubscriptions(event);
    }

    const channelID = this._getChannelID();
    let subscriptions = this._getSubscriptions() || {};

    const { headers } = event;

    if (
      !headers["x-goog-resource-state"] ||
      !headers["x-goog-resource-id"] ||
      !headers["x-goog-resource-uri"] ||
      !headers["x-goog-message-number"]
    ) {
      console.log("Request missing necessary headers: ", headers);
      return;
    }

    const incomingChannelID = headers["x-goog-channel-id"];
    if (incomingChannelID !== channelID) {
      console.log(
        `Channel ID of ${incomingChannelID} not equal to deployed component channel of ${channelID}`,
      );
      return;
    }

    if (subscriptions[headers["x-goog-resource-id"]] === undefined) {
      console.log(
        `Resource ID of ${headers["x-goog-resource-id"]} not currently being tracked. Exiting`,
      );
      return;
    }

    if (!includes(this.updateTypes, headers["x-goog-resource-state"])) {
      console.log(
        `Update type ${headers["x-goog-resource-state"]} not in list of updates to watch: `,
        this.updateTypes,
      );
      return;
    }

    // We observed false positives where a single change to a document would trigger two changes:
    // one to "properties" and another to "content,properties". But changes to properties
    // alone are legitimate, most users just won't want this source to emit in those cases.
    // If x-goog-changed is _only_ set to "properties", only move on if the user set the prop
    if (
      !this.watchForPropertiesChanges &&
      headers["x-goog-changed"] === "properties"
    ) {
      console.log(
        "Change to properties only, which this component is set to ignore. Exiting",
      );
      return;
    }

    const file = await this.googleDrive.getFileMetadata(
      headers["x-goog-resource-uri"],
    );

    if (!file || !Object.keys(file).length) {
      console.log("No file metadata returned, nothing to emit");
      return;
    }

    const [
      checkedFile,
    ] = this.checkMinimumInterval([
      file,
    ]);
    if (checkedFile) {
      await this.processChange(file, headers);
    }
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Google Drive	`googleDrive`	`app`	This component uses the Google Drive app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Drive	`drive`	`string`	Defaults to `My Drive`. To use a Shared Drive, use the Changes to Specific Files (Shared Drive) source instead.
Files	`files`	`string[]`	Select a value from the drop down menu.
Include Link	`includeLink`	`boolean`	Upload file to your File Stash and emit temporary download link to the file. Google Workspace documents will be converted to PDF. See the docs to learn more about working with files in Pipedream.
	`dir`	`dir`
Minimum Interval Per File	`perFileInterval`	`integer`	How many minutes to wait until the same file can emit another event. If set to `0`, this interval is disabled and all events will be emitted.
Types of updates	`updateTypes`	`string[]`	Select a value from the drop down menu:`{ "label": "'sync' - A channel was successfully created. You can expect to start receiving notifications for it.", "value": "sync" }{ "label": "'add' - A resource was created or shared.", "value": "add" }{ "label": "'remove' - An existing resource was deleted or unshared.", "value": "remove" }{ "label": "'update' - One or more properties (metadata) of a resource have been updated.", "value": "update" }{ "label": "'trash' - A resource has been moved to the trash.", "value": "trash" }{ "label": "'untrash' - A resource has been removed from the trash.", "value": "untrash" }{ "label": "'change' - One or more changelog items have been added.", "value": "change" }`

Trigger Authentication#

Google Drive uses OAuth authentication. When you connect your Google Drive account, Pipedream will open a popup window where you can sign into Google Drive and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Drive API.

Pipedream requests the following authorization scopes when you connect your account:

https://www.googleapis.com/auth/drive

About Google Drive#

Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.

Action#

Create Requirement on PractiTest

Description:Create a requirement [See docs here](https://www.practitest.com/api-v2/#create-a-requirement)

Version:0.0.2

Key:practitest-create-requirement

View on GitHub

PractiTest Overview#

PractiTest is a test management tool that facilitates the organization, tracking, and planning of software testing processes by integrating with Pipedream's automation capabilities. With the PractiTest API, you're able to manipulate test cases, sets, runs, and report on results programmatically. This powerful combination opens the door to automated workflows that enhance testing processes, improve bug tracking, and provide real-time feedback to your team.

Action Code#

import practitest from "../../app/practitest.app.mjs";
import { defineAction } from "@pipedream/types";
import { DOCS } from "../../common/constants.mjs";
export default defineAction({
    name: "Create Requirement",
    description: `Create a requirement [See docs here](${DOCS.createRequirement})`,
    key: "practitest-create-requirement",
    version: "0.0.2",
    annotations: {
        destructiveHint: false,
        openWorldHint: true,
        readOnlyHint: false,
    },
    type: "action",
    props: {
        practitest,
        projectId: {
            propDefinition: [
                practitest,
                "project",
            ],
        },
        name: {
            type: "string",
            label: "Name",
            description: "Name of the requirement",
        },
        authorId: {
            propDefinition: [
                practitest,
                "user",
            ],
            label: "Author",
        },
        description: {
            type: "string",
            label: "Description",
            description: "Description of the requirement",
            optional: true,
        },
        assignedToId: {
            propDefinition: [
                practitest,
                "user",
            ],
            label: "Assigned To",
            optional: true,
        },
        version: {
            propDefinition: [
                practitest,
                "version",
            ],
            description: "String of the requirement's version",
        },
        priority: {
            type: "string",
            label: "Priority",
            description: "String of the requirement's priority",
            optional: true,
        },
        customFields: {
            propDefinition: [
                practitest,
                "customFields",
            ],
        },
        parentId: {
            type: "string",
            label: "Parent ID",
            description: "A parent's requirement ID",
            optional: true,
        },
        testIds: {
            type: "integer[]",
            label: "Test IDs",
            description: "An array of test-ids to add to the traceability of the new requirement",
            optional: true,
        },
        tags: {
            type: "string[]",
            label: "Tags",
            description: "An array of tags for the requirement",
            optional: true,
        },
    },
    async run({ $ }) {
        const { projectId, name, authorId, description, assignedToId, version, priority, customFields, parentId, testIds, tags, } = this;
        const params = {
            $,
            projectId,
            attributes: {
                name,
                "author-id": authorId,
                description,
                "assigned-to-id": assignedToId,
                version,
                priority,
                "custom-fields": customFields,
                "parent-id": parentId,
                tags,
            },
        };
        if (testIds) {
            params.traceability = {
                "test-ids": testIds,
            };
        }
        const response = await this.practitest.createRequirement(params);
        $.export("$summary", `Successfully created requirement (id ${response.data.id})`);
        return response;
    },
});

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
PractiTest	`practitest`	`app`	This component uses the PractiTest app.
Project	`projectId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Name of the requirement
Author	`authorId`	`string`	Select a value from the drop down menu.
Description	`description`	`string`	Description of the requirement
Assigned To	`assignedToId`	`string`	Select a value from the drop down menu.
Version	`version`	`string`	String of the requirement's version
Priority	`priority`	`string`	String of the requirement's priority
Custom Fields	`customFields`	`object`	A hash of custom-fields with their value
Parent ID	`parentId`	`string`	A parent's requirement ID
Test IDs	`testIds`	`integer[]`	An array of test-ids to add to the traceability of the new requirement
Tags	`tags`	`string[]`	An array of tags for the requirement

Action Authentication#

PractiTest uses API keys for authentication. When you connect your PractiTest account, Pipedream securely stores the keys so you can easily authenticate to PractiTest APIs in both code and no-code steps.

PractiTest uses API tokens for authentication. You can create a new API token by going to the Account Settings - “API Tokens”, or going to your personal settings for Personal Tokens. Please visit API tokens for more information.

About PractiTest#

Empower organizations to create, deploy and run software with confidence.

More Ways to Connect PractiTest + Google Drive#

Other Popular Integrations#

Create Requirement with PractiTest API on Changes to Specific Files (Shared Drive) from Google Drive API

Google Drive + PractiTest

Create Requirement with PractiTest API on Changes to Specific Files from Google Drive API

Pipedream makes it easy to connect APIs for PractiTest, Google Drive and 2,900+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,900+apps by most popular

1
-
24
of
2,900+
apps by most popular