Introducing Socket Firewall: Free, Proactive Protection for Your Software Supply Chain.Learn More →
Socket
Book a DemoInstallSign in
Socket
Book a DemoInstallSign in

@cumulus/integration-tests

Package Overview
Dependencies
Maintainers
6
Versions
192
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@cumulus/integration-tests

Integration tests

latest
Source
npmnpm
Version
21.0.0
Version published
Weekly downloads
738
1035.38%
Maintainers
6
Weekly downloads
 
Created
Source

@cumulus/integration-tests

This package provides a CLI and functions for testing Cumulus.

⚠️ The documented API of this package will not change without a deprecation warning being provided in earlier releases. Code in this package that is not documented in this README may change without warning, and is not considered part of the package's public API.

About Cumulus

Cumulus is a cloud-based data ingest, archive, distribution and management prototype for NASA's future Earth science data streams.

Cumulus Documentation

Installation

$ npm install @cumulus/integration-tests

API

Modules

Collections
Executions
Granules
Providers
Rules

Collections

Example

const Collections = require('@cumulus/integration-test/Collections');

createCollection(prefix, [overrides]) ⇒ Promise.<Object> ⏏

Create a randomized collection using the Cumulus API.

The default collection is very simple. It expects that, for any discovered file, the granule ID is everything in the filename before the extension. For example, a file named gran-1.txt would have a granuleId of gran-1. Filenames can only contain a single . character.

Collection defaults:

  • name: random string starting with collection-name-
  • version: random string starting with collection-version-
  • reportToEms: false
  • granuleId: '^[^.]+$'
  • granuleIdExtraction: '^([^.]+)\..+$'
  • sampleFileName: 'asdf.jpg'
  • files: 
    [
  {
    bucket: 'protected',
    regex: '^[^.]+\..+$',
    sampleFileName: 'asdf.jpg'
  }
]

Kind: Exported function
Returns: Promise.<Object> - the generated collection

ParamTypeDescription
prefixstringthe Cumulus stack name
[overrides]Objectproperties to set on the collection, overriding the defaults

createCollection~addCustomUrlPathToCollectionFiles(collection, customFilePath) ⇒ Array.<Object>

Given a Cumulus collection configuration, return a list of the filetype configs with their url_paths updated.

Kind: inner method of createCollection
Returns: Array.<Object> - a list of collection filetype configs

ParamTypeDescription
collectionObjecta Cumulus collection
customFilePathstringpath to be added to the end of the url_path

createCollection~buildCollection(params) ⇒ Object

Update a collection with a custom file path, duplicate handling, and name updated with the postfix.

Kind: inner method of createCollection
Returns: Object - an updated collection

ParamTypeDescription
paramsObject
params.collectionObjecta collection configuration
params.customFilePathstringpath to be added to the end of the url_path
params.duplicateHandlingstringduplicate handling setting
params.postfixstringa string to be appended to the end of the name

createCollection~collectionExists(stackName, collection) ⇒ boolean

Returns true if collection exists. False otherwise.

Kind: inner method of createCollection

ParamTypeDescription
stackNamestringthe prefix of the Cumulus stack
collectionObjecta Cumulus collection

createCollection~addCollection(stackName, collection) ⇒ Promise.<undefined>

Add a new collection to Cumulus

Kind: inner method of createCollection

ParamTypeDescription
stackNamestringthe prefix of the Cumulus stack
collectionObjecta Cumulus collection

createCollection~addCollections(stackName, bucketName, dataDirectory, [postfix], [customFilePath], [duplicateHandling]) ⇒ Promise.<Array.<Object>>

Add collections to database

Kind: inner method of createCollection
Returns: Promise.<Array.<Object>> - - collections that were added

ParamTypeDescription
stackNamestringCloud formation stack name
bucketNamestringS3 internal bucket name
dataDirectorystringthe directory of collection json files
[postfix]stringstring to append to collection name
[customFilePath]string
[duplicateHandling]string

Executions

Example

const Executions = require('@cumulus/integration-test/Executions');

findExecutionArn(prefix, matcher, [queryParameters], [options]) ⇒ Promise.<string> ⏏

Find the execution ARN matching the matcher function

Kind: Exported function
Returns: Promise.<string> - the ARN of the matching execution

ParamTypeDefaultDescription
prefixstringthe name of the Cumulus stack
matcherfunctiona predicate function that takes an execution and determines if this is the execution that is being searched for
[queryParameters]ObjectOptional query parameters
[options]Object
[options.timeout]integer0the number of seconds to wait for a matching execution to be found

getExecutionWithStatus(params) ⇒ Promise.<Object> ⏏

Wait for an execution to have an expected status and return the execution

Kind: Exported function
Returns: Promise.<Object> - the execution as returned by the GET /executions/<execution-arn> endpoint

ParamTypeDefaultDescription
paramsObject
params.prefixstringthe name of the Cumulus stack
params.arnstringthe execution ARN to fetch
params.statusstringthe status to wait for
[params.callback]functioncumulusApiClient.invokeApifunctionan async function to invoke the API Lambda that takes a prefix / user payload
[params.timeout]integer30the number of seconds to wait for the execution to reach a terminal state

Granules

Example

const Granules = require('@cumulus/integration-test/Granules');

getGranuleWithStatus(params) ⇒ Promise.<Object> ⏏

Wait for a granule to have an expected status and return the granule

Kind: Exported function
Returns: Promise.<Object> - the granule as returned by the GET /granules/<granule-id> endpoint

ParamTypeDefaultDescription
paramsObject
params.prefixstringthe name of the Cumulus stack
params.granuleIdstringthe granuleId of the granule
params.collectionIdstringthe collectionId of the granule
params.statusstringthe status to wait for
params.updatedAtstringminimum updatedAt time the granule must have to return
[params.callback]functioncumulusApiClient.invokeApifunctionan async function to invoke the API Lambda that takes a prefix / user payload
[params.timeout]integer30the number of seconds to wait for the execution to reach a terminal state

getGranuleWithStatus~waitForListGranulesResult(params) ⇒ Promise.<Object>

Wait for listGranules to return at least a single value before returning an empty result

Kind: inner method of getGranuleWithStatus
Returns: Promise.<Object> - - results of a successful listGranules

ParamTypeDescription
paramsObjectparameters to listGranules function

Providers

Example

const Providers = require('@cumulus/integration-test/Providers');

createProvider(prefix, [overrides]) ⇒ Promise.<Object> ⏏

Create a provider using the Cumulus API

Provider defaults:

  • id: random string starting with provider-
  • protocol: s3
  • globalConnectionLimit: 10

Kind: Exported function
Returns: Promise.<Object> - the generated provider

ParamTypeDescription
prefixstringthe Cumulus stack name
[overrides]Objectproperties to set on the provider, overriding the defaults

Rules

Example

const Rules = require('@cumulus/integration-test/Rules');

createOneTimeRule(prefix, [overrides]) ⇒ Promise.<Object> ⏏

Create a onetime rule using the Cumulus API

Rule defaults:

  • name: random string starting with rule_
  • rule: { type: 'onetime' }

Kind: Exported function
Returns: Promise.<Object> - the generated rule

ParamTypeDescription
prefixstringthe name of the Cumulus stack
[overrides]Objectproperties to set on the rule, overriding the defaults

CLI Usage

Usage: cumulus-test TYPE COMMAND [options]


  Options:

    -V, --version                   output the version number
    -s, --stack-name <stackName>    AWS Cloud Formation stack name (default: null)
    -b, --bucket-name <bucketName>  AWS S3 internal bucket name (default: null)
    -w, --workflow <workflow>       Workflow name (default: null)
    -i, --input-file <inputFile>    Workflow input JSON file (default: null)
    -h, --help                      output usage information


  Commands:

    workflow  Execute a workflow and determine if the workflow completes successfully

For example, to test the HelloWorld workflow:

cumulus-test workflow --stack-name helloworld-cumulus --bucket-name cumulus-bucket-internal --workflow HelloWorldWorkflow --input-file ./helloWorldInput.json

Contributing

To make a contribution, please see our contributing guidelines.

Generated automatically using npm run build-docs

FAQs

Package last updated on 10 Sep 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

Vite+ Joins the Push to Consolidate JavaScript Tooling

Security News

Vite+ Joins the Push to Consolidate JavaScript Tooling

Evan You announces Vite+, a commercial, Rust-powered toolchain built on the Vite ecosystem to unify JavaScript development and fund open source.

By Sarah Gooding  -  Oct 15, 2025