Jk/cumulus 3135 fix integration tests

CHANGELOG.md

@@ -11,6 +11,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - **CUMULUS-2985**
   - Changed `onetime` rules RuleTrigger to only execute when the state is `ENABLED` and updated documentation to reflect the change
   - Changed the `invokeRerun` function to only re-run enabled rules
+- **CUMULUS-3315**
+  - Updated `@cumulus/api-client/granules.bulkOperation` to remove `ids`
+    parameter in favor of `granules` parameter, in the form of a
+    `@cumulus/types/ApiGranule` that requires the following keys: `[granuleId, collectionId]`
 
 ### Fixed
 

example/spec/parallel/ingestGranule/IngestGranuleSuccessSpec.js

@@ -114,6 +114,7 @@ describe('The S3 Ingest Granules workflow', () => {
 
   let beforeAllError;
   let collection;
+  let collectionId;
   let config;
   let expectedPayload;
   let expectedS3TagSet;
@@ -140,7 +141,7 @@ describe('The S3 Ingest Granules workflow', () => {
       testDataFolder = createTestDataPath(testId);
 
       collection = { name: `MOD09GQ${testSuffix}`, version: '006' };
-      const newCollectionId = constructCollectionId(collection.name, collection.version);
+      collectionId = constructCollectionId(collection.name, collection.version);
       provider = { id: `s3_provider${testSuffix}` };
 
       process.env.system_bucket = config.bucket;
@@ -193,7 +194,7 @@ describe('The S3 Ingest Granules workflow', () => {
         },
       });
 
-      expectedSyncGranulePayload = loadFileWithUpdatedGranuleIdPathAndCollection(templatedSyncGranuleFilename, granuleId, testDataFolder, newCollectionId, config.stackName);
+      expectedSyncGranulePayload = loadFileWithUpdatedGranuleIdPathAndCollection(templatedSyncGranuleFilename, granuleId, testDataFolder, collectionId, config.stackName);
 
       expectedSyncGranulePayload.granules[0].dataType += testSuffix;
       expectedSyncGranulePayload.granules[0].files[0].checksumType = inputPayload.granules[0].files[0].checksumType;
@@ -231,7 +232,7 @@ describe('The S3 Ingest Granules workflow', () => {
         },
       });
 
-      expectedPayload = loadFileWithUpdatedGranuleIdPathAndCollection(templatedOutputPayloadFilename, granuleId, testDataFolder, newCollectionId);
+      expectedPayload = loadFileWithUpdatedGranuleIdPathAndCollection(templatedOutputPayloadFilename, granuleId, testDataFolder, collectionId);
       expectedPayload.granules[0].dataType += testSuffix;
 
       // process.env.DISTRIBUTION_ENDPOINT needs to be set for below
@@ -932,7 +933,16 @@ describe('The S3 Ingest Granules workflow', () => {
             bulkReingestResponse = await bulkReingestGranules({
               prefix: config.stackName,
               body: {
-                ids: [reingestGranuleId, fakeGranuleId],
+                granules: [
+                  {
+                    collectionId,
+                    granuleId: reingestGranuleId,
+                  },
+                  {
+                    collectionId,
+                    granuleId: fakeGranuleId,
+                  },
+                ],
               },
             });
           } catch (error) {

example/spec/parallel/orca/OrcaBackupAndRecoverySpec.js

@@ -20,6 +20,7 @@ const {
   waitForCompletedExecution,
 } = require('@cumulus/integration-tests');
 const { LambdaStep } = require('@cumulus/integration-tests/sfnStep');
+const { constructCollectionId } = require('@cumulus/message/Collections');
 
 const { removeCollectionAndAllDependencies } = require('../../helpers/Collections');
 const { buildAndStartWorkflow } = require('../../helpers/workflowUtils');
@@ -163,7 +164,10 @@ describe('The S3 Ingest Granules workflow', () => {
 
       const response = await bulkOperation({
         prefix: config.stackName,
-        ids: [granuleId],
+        granules: [{
+          granuleId,
+          collectionId: constructCollectionId(collection.name, collection.version),
+        }],
         workflowName: recoveryWorkflowName,
       });
 

packages/api-client/src/granules.ts

@@ -1,6 +1,6 @@
 import pRetry from 'p-retry';
 
-import { ApiGranuleRecord, GranuleId, GranuleStatus } from '@cumulus/types/api/granules';
+import { ApiGranuleRecord, ApiGranule, GranuleId, GranuleStatus } from '@cumulus/types/api/granules';
 import { CollectionId } from '@cumulus/types/api/collections';
 import Logger from '@cumulus/logger';
 
@@ -612,7 +612,7 @@ export const associateExecutionWithGranule = async (params: {
  */
 export const bulkGranules = async (params: {
   prefix: string,
-  body: object,
+  body: unknown,
   callback?: InvokeApiFunction
 }): Promise<ApiGatewayLambdaHttpProxyResponse> => {
   const { prefix, body, callback = invokeApi } = params;
@@ -693,7 +693,7 @@ export const bulkReingestGranules = async (params: {
  *
  * @param {Object} params - params
  * @param {string} params.prefix - the prefix configured for the stack
- * @param {Array<string>} params.ids - the granules to have bulk operation on
+ * @param {Array<ApiGranuleRecord>} params.granules - the granules to have bulk operation on
  * @param {string} params.workflowName - workflowName for the bulk operation execution
  * @param {Function} params.callback  - async function to invoke the api lambda
  *                                      that takes a prefix / user payload.  Defaults
@@ -703,11 +703,11 @@ export const bulkReingestGranules = async (params: {
  */
 export const bulkOperation = async (params: {
   prefix: string,
-  ids: string[],
+  granules: ApiGranule[],
   workflowName: string,
   callback?: InvokeApiFunction
 }): Promise<ApiGatewayLambdaHttpProxyResponse> => {
-  const { prefix, ids, workflowName, callback = invokeApi } = params;
+  const { prefix, granules, workflowName, callback = invokeApi } = params;
   return await callback({
     prefix: prefix,
     payload: {
@@ -717,7 +717,7 @@ export const bulkOperation = async (params: {
       headers: {
         'Content-Type': 'application/json',
       },
-      body: JSON.stringify({ ids, workflowName }),
+      body: JSON.stringify({ granules, workflowName }),
     },
     expectedStatusCodes: 202,
   });

packages/api-client/tests/test-granules.js

@@ -531,3 +531,38 @@ test('associateExecutionWithGranule calls the callback with the expected object'
     body,
   }));
 });
+
+test('bulkOperation calls the callback with the expected object', async (t) => {
+  const workflowName = randomId('workflowName');
+  const granuleId = t.context.granuleId;
+  const collectionId = randomId('collectionId');
+  const granules = [{ granuleId, collectionId }];
+
+  const expected = {
+    prefix: t.context.testPrefix,
+    payload: {
+      httpMethod: 'POST',
+      resource: '/{proxy+}',
+      path: '/granules/bulk/',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({
+        granules,
+        workflowName,
+      }),
+    },
+    expectedStatusCodes: 202,
+  };
+
+  const callback = (configObject) => {
+    t.deepEqual(configObject, expected);
+  };
+
+  await t.notThrowsAsync(
+    granulesApi.bulkOperation({
+      callback,
+      prefix: t.context.testPrefix,
+      granules,
+      workflowName,
+    })
+  );
+});