@cumulus/integration-tests 10.1.2 → 11.0.0

package/Collections.js

@@ -9,6 +9,7 @@
  */
 
 const isString = require('lodash/isString');
+const pRetry = require('p-retry');
 
 const CollectionsApi = require('@cumulus/api-client/collections');
 const { randomId } = require('@cumulus/common/test-utils');
@@ -96,6 +97,43 @@ const buildRandomizedCollection = (overrides = {}) => ({
   ...overrides,
 });
 
+/**
+ * Returns true if collection exists. False otherwise.
+ *
+ * @param {string} stackName - the prefix of the Cumulus stack
+ * @param {Object} collection - a Cumulus collection
+ * @returns {boolean}
+ */
+const collectionExists = async (stackName, collection) => {
+  let response;
+  const exists = await pRetry(
+    async () => {
+      try {
+        response = await CollectionsApi.getCollection({
+          prefix: stackName,
+          collectionName: collection.name,
+          collectionVersion: collection.version,
+          pRetryOptions: {
+            retries: 0,
+          },
+        });
+      } catch (error) {
+        if (error.statusCode === 404) {
+          console.log(`Error: ${error}. Failed to get collection ${JSON.stringify(collection)}`);
+          return false;
+        }
+        throw error;
+      }
+      if (response.statusCode === 200) {
+        return true;
+      }
+      return false;
+    },
+    { retries: 5, minTimeout: 2000, maxTimeout: 2000 }
+  );
+  return exists;
+};
+
 /**
  * Add a new collection to Cumulus
  *
@@ -103,12 +141,18 @@ const buildRandomizedCollection = (overrides = {}) => ({
  * @param {Object} collection - a Cumulus collection
  * @returns {Promise<undefined>}
  */
-const addCollection = async (stackName, collection) => {
-  await CollectionsApi.deleteCollection({
-    prefix: stackName,
-    collectionName: collection.name,
-    collectionVersion: collection.version,
-  });
+const addCollection = async (
+  stackName,
+  collection
+) => {
+  const exists = await collectionExists(stackName, collection);
+  if (exists) {
+    await CollectionsApi.deleteCollection({
+      prefix: stackName,
+      collectionName: collection.name,
+      collectionVersion: collection.version,
+    });
+  }
   const response = await CollectionsApi.createCollection({ prefix: stackName, collection });
   if (response.statusCode !== 200) {
     throw new Error(`Collections API did not return 200: ${JSON.stringify(response)}`);

package/Executions.js

@@ -21,6 +21,7 @@ const EXECUTION_LIST_LIMIT = 50;
  * @param {string} prefix - the name of the Cumulus stack
  * @param {Function} matcher - a predicate function that takes an execution and determines if this
  * is the execution that is being searched for
+ * @param {Object} [queryParameters] - Optional query parameters
  * @param {Object} [options]
  * @param {integer} [options.timeout=0] - the number of seconds to wait for a matching execution
  * to be found
@@ -46,7 +47,7 @@ const findExecutionArn = async (prefix, matcher, queryParameters = { }, options
         let executions = JSON.parse(body);
         const { results } = executions;
         if (isNil(results)) {
-          throw new Error('Not Found');
+          throw new Error('API executions list was empty');
         }
 
         execution = results.find(matcher);
@@ -68,7 +69,7 @@ const findExecutionArn = async (prefix, matcher, queryParameters = { }, options
         throw new pRetry.AbortError(error);
       }
 
-      if (isNil(execution)) throw new Error('Not Found');
+      if (isNil(execution)) throw new Error('Execution never found in API');
 
       return execution.arn;
     },

package/README.md

@@ -49,6 +49,7 @@ const Collections = require('@cumulus/integration-test/Collections');
     * [createCollection(prefix, [overrides])](#exp_module_Collections--createCollection) ⇒ <code>Promise.&lt;Object&gt;</code> ⏏
         * [~addCustomUrlPathToCollectionFiles(collection, customFilePath)](#module_Collections--createCollection..addCustomUrlPathToCollectionFiles) ⇒ <code>Array.&lt;Object&gt;</code>
         * [~buildCollection(params)](#module_Collections--createCollection..buildCollection) ⇒ <code>Object</code>
+        * [~collectionExists(stackName, collection)](#module_Collections--createCollection..collectionExists) ⇒ <code>boolean</code>
         * [~addCollection(stackName, collection)](#module_Collections--createCollection..addCollection) ⇒ <code>Promise.&lt;undefined&gt;</code>
         * [~addCollections(stackName, bucketName, dataDirectory, [postfix], [customFilePath], [duplicateHandling])](#module_Collections--createCollection..addCollections) ⇒ <code>Promise.&lt;Array.&lt;Object&gt;&gt;</code>
 
@@ -119,6 +120,18 @@ updated with the postfix.
 | params.duplicateHandling | <code>string</code> | duplicate handling setting |
 | params.postfix | <code>string</code> | a string to be appended to the end of the   name |
 
+<a name="module_Collections--createCollection..collectionExists"></a>
+
+#### createCollection~collectionExists(stackName, collection) ⇒ <code>boolean</code>
+Returns true if collection exists. False otherwise.
+
+**Kind**: inner method of [<code>createCollection</code>](#exp_module_Collections--createCollection)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| stackName | <code>string</code> | the prefix of the Cumulus stack |
+| collection | <code>Object</code> | a Cumulus collection |
+
 <a name="module_Collections--createCollection..addCollection"></a>
 
 #### createCollection~addCollection(stackName, collection) ⇒ <code>Promise.&lt;undefined&gt;</code>
@@ -157,12 +170,12 @@ const Executions = require('@cumulus/integration-test/Executions');
 ```
 
 * [Executions](#module_Executions)
-    * [findExecutionArn(prefix, matcher, [options])](#exp_module_Executions--findExecutionArn) ⇒ <code>Promise.&lt;string&gt;</code> ⏏
+    * [findExecutionArn(prefix, matcher, [queryParameters], [options])](#exp_module_Executions--findExecutionArn) ⇒ <code>Promise.&lt;string&gt;</code> ⏏
     * [getExecutionWithStatus(params)](#exp_module_Executions--getExecutionWithStatus) ⇒ <code>Promise.&lt;Object&gt;</code> ⏏
 
 <a name="exp_module_Executions--findExecutionArn"></a>
 
-### findExecutionArn(prefix, matcher, [options]) ⇒ <code>Promise.&lt;string&gt;</code> ⏏
+### findExecutionArn(prefix, matcher, [queryParameters], [options]) ⇒ <code>Promise.&lt;string&gt;</code> ⏏
 Find the execution ARN matching the `matcher` function
 
 **Kind**: Exported function  
@@ -172,6 +185,7 @@ Find the execution ARN matching the `matcher` function
 | --- | --- | --- | --- |
 | prefix | <code>string</code> |  | the name of the Cumulus stack |
 | matcher | <code>function</code> |  | a predicate function that takes an execution and determines if this is the execution that is being searched for |
+| [queryParameters] | <code>Object</code> |  | Optional query parameters |
 | [options] | <code>Object</code> |  |  |
 | [options.timeout] | <code>integer</code> | <code>0</code> | the number of seconds to wait for a matching execution to be found |