@datadog/datadog-ci 2.40.1 → 2.40.3

package/dist/commands/stepfunctions/__tests__/helpers.test.js

@@ -0,0 +1,205 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const client_sfn_1 = require("@aws-sdk/client-sfn");
+const helpers_1 = require("../helpers");
+const aws_resources_1 = require("./fixtures/aws-resources");
+describe('stepfunctions command helpers tests', () => {
+    describe('shouldUpdateStepForTracesMerging test', () => {
+        test('already has JsonMerge added to payload field', () => {
+            const step = {
+                Type: 'Task',
+                Resource: 'arn:aws:states:::lambda:invoke',
+                Parameters: {
+                    FunctionName: 'arn:aws:lambda:sa-east-1:425362991234:function:unit-test-lambda-function',
+                    'Payload.$': 'States.JsonMerge($$, $, false)',
+                },
+                End: true,
+            };
+            expect((0, helpers_1.shouldUpdateStepForTracesMerging)(step)).toBeFalsy();
+        });
+        test('no payload field', () => {
+            const step = {
+                Type: 'Task',
+                Resource: 'arn:aws:states:::lambda:invoke',
+                Parameters: {
+                    FunctionName: 'arn:aws:lambda:sa-east-1:425362991234:function:unit-test-lambda-function',
+                },
+                End: true,
+            };
+            expect((0, helpers_1.shouldUpdateStepForTracesMerging)(step)).toBeTruthy();
+        });
+        test('default payload field of $', () => {
+            const step = {
+                Type: 'Task',
+                Resource: 'arn:aws:states:::lambda:invoke',
+                Parameters: {
+                    FunctionName: 'arn:aws:lambda:sa-east-1:425362991234:function:unit-test-lambda-function',
+                    'Payload.$': '$',
+                },
+                End: true,
+            };
+            expect((0, helpers_1.shouldUpdateStepForTracesMerging)(step)).toBeTruthy();
+        });
+        test('none-lambda step should not be updated', () => {
+            const step = {
+                Type: 'Task',
+                Resource: 'arn:aws:states:::dynamodb:updateItem',
+                Parameters: {
+                    TableName: 'step-functions-tracing-self-monitoring-table-staging',
+                },
+                End: true,
+            };
+            expect((0, helpers_1.shouldUpdateStepForTracesMerging)(step)).toBeFalsy();
+        });
+        test('legacy lambda api should not be updated', () => {
+            const step = {
+                Type: 'Task',
+                Resource: 'arn:aws:lambda:sa-east-1:601427271234:function:hello-function',
+                End: true,
+            };
+            expect((0, helpers_1.shouldUpdateStepForTracesMerging)(step)).toBeFalsy();
+        });
+    });
+    describe('buildArn', () => {
+        test('builds log group arn', () => {
+            const partition = 'aws';
+            const service = 'logs';
+            const region = 'us-east-1';
+            const accountId = '000000000000';
+            const resourceType = 'log-group';
+            const resourceId = '/aws/vendedlogs/states/ExampleStepFunction-Logs-test:*';
+            const logGroupArn = (0, helpers_1.buildArn)(partition, service, region, accountId, resourceType, resourceId);
+            expect(logGroupArn).toBe('arn:aws:logs:us-east-1:000000000000:log-group:/aws/vendedlogs/states/ExampleStepFunction-Logs-test:*');
+        });
+    });
+    describe('buildLogGroupName', () => {
+        test('builds log group name from step function name with env', () => {
+            const stepFunction = (0, aws_resources_1.describeStateMachineFixture)();
+            const env = 'test';
+            const logGroupName = (0, helpers_1.buildLogGroupName)(stepFunction.name, env);
+            expect(logGroupName).toBe('/aws/vendedlogs/states/ExampleStepFunction-Logs-test');
+        });
+        test('builds log group name from step function name without env', () => {
+            const stepFunction = (0, aws_resources_1.describeStateMachineFixture)();
+            let env;
+            const logGroupName = (0, helpers_1.buildLogGroupName)(stepFunction.name, env);
+            expect(logGroupName).toBe('/aws/vendedlogs/states/ExampleStepFunction-Logs');
+        });
+    });
+    describe('buildSubscriptionFilterName', () => {
+        test('builds subscription filter name from step function name', () => {
+            const stepFunction = (0, aws_resources_1.describeStateMachineFixture)();
+            const subscriptionFilterName = (0, helpers_1.buildSubscriptionFilterName)(stepFunction.name);
+            expect(subscriptionFilterName).toBe('ExampleStepFunction-DdCiLogGroupSubscription');
+        });
+    });
+    describe('isValidArn', () => {
+        test('returns true for valid step function arn', () => {
+            const stepFunction = (0, aws_resources_1.describeStateMachineFixture)();
+            expect((0, helpers_1.isValidArn)(stepFunction.stateMachineArn)).toBe(true);
+        });
+        test('returns true for valid lambda function arn', () => {
+            const lambdaFunctionArn = 'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder';
+            expect((0, helpers_1.isValidArn)(lambdaFunctionArn)).toBe(true);
+        });
+        test('returns false for invalid arn', () => {
+            const arn = '';
+            expect((0, helpers_1.isValidArn)(arn)).toBe(false);
+        });
+    });
+    describe('getStepFunctionLogGroupArn', () => {
+        test('returns step function log group arn when it is set', () => {
+            const stepFunction = (0, aws_resources_1.describeStateMachineFixture)();
+            const logGroupArn = (0, helpers_1.getStepFunctionLogGroupArn)(stepFunction);
+            expect(logGroupArn).toBe('arn:aws:logs:us-east-1:000000000000:log-group:/aws/vendedlogs/states/ExampleStepFunction-Logs-test:*');
+        });
+        test('returns undefined when step function logging is off', () => {
+            const loggingConfiguration = {
+                level: client_sfn_1.LogLevel.OFF,
+                includeExecutionData: false,
+            };
+            const stepFunction = (0, aws_resources_1.describeStateMachineFixture)({ loggingConfiguration });
+            const logGroupArn = (0, helpers_1.getStepFunctionLogGroupArn)(stepFunction);
+            expect(logGroupArn).toBe(undefined);
+        });
+    });
+    describe('parseArn', () => {
+        test('parses step function arn', () => {
+            const stepFunction = (0, aws_resources_1.describeStateMachineFixture)();
+            const arnObject = (0, helpers_1.parseArn)(stepFunction.stateMachineArn);
+            expect(arnObject.partition).toBe('aws');
+            expect(arnObject.region).toBe('us-east-1');
+            expect(arnObject.accountId).toBe('000000000000');
+            expect(arnObject.resourceName).toBe('ExampleStepFunction');
+        });
+    });
+    describe('shouldUpdateStepForStepFunctionContextInjection', () => {
+        test('is true for an empty object', () => {
+            const step = {
+                Type: 'Task',
+                Resource: 'arn:aws:states:::states:startExecution.sync:2',
+                Parameters: {
+                    StateMachineArn: 'arn:aws:states:us-east-1:425362996713:stateMachine:agocs_inner_state_machine',
+                    Input: {},
+                },
+                End: true,
+            };
+            expect((0, helpers_1.shouldUpdateStepForStepFunctionContextInjection)(step)).toBeTruthy();
+        });
+        test('is true for undefined', () => {
+            const step = {
+                Type: 'Task',
+                Resource: 'arn:aws:states:::states:startExecution.sync:2',
+                Parameters: {
+                    StateMachineArn: 'arn:aws:states:us-east-1:425362996713:stateMachine:agocs_inner_state_machine',
+                },
+                End: true,
+            };
+            expect((0, helpers_1.shouldUpdateStepForStepFunctionContextInjection)(step)).toBeTruthy();
+        });
+        test('is false when Input is an object that contains a CONTEXT key', () => {
+            const step = {
+                Type: 'Task',
+                Resource: 'arn:aws:states:::states:startExecution.sync:2',
+                Parameters: {
+                    StateMachineArn: 'arn:aws:states:us-east-1:425362996713:stateMachine:agocs_inner_state_machine',
+                    Input: { 'CONTEXT.$': 'blah' },
+                },
+                End: true,
+            };
+            expect((0, helpers_1.shouldUpdateStepForStepFunctionContextInjection)(step)).toBeFalsy();
+        });
+    });
+    describe('inject context for StepFunctions', () => {
+        test('injects context into a step function invocation', () => {
+            var _a;
+            const step = {
+                Type: 'Task',
+                Resource: 'arn:aws:states:::states:startExecution.sync:2',
+                Parameters: {
+                    StateMachineArn: 'arn:aws:states:us-east-1:425362996713:stateMachine:agocs_inner_state_machine',
+                    Input: {},
+                },
+                End: true,
+            };
+            const changed = (0, helpers_1.injectContextForStepFunctions)(step);
+            expect(changed).toBeTruthy();
+            expect((_a = step.Parameters) === null || _a === void 0 ? void 0 : _a.Input).toEqual({ 'CONTEXT.$': 'States.JsonMerge($$, $, false)' });
+        });
+    });
+    test('buildLogAccessPolicyName test', () => {
+        const fakeStateMachineName = 'fakeStateMachineName';
+        const describeStateMachineCommandOutput = {
+            $metadata: {},
+            creationDate: undefined,
+            definition: undefined,
+            roleArn: undefined,
+            type: undefined,
+            stateMachineArn: 'fakeStepFunctionArn',
+            name: fakeStateMachineName,
+        };
+        const actual = (0, helpers_1.buildLogAccessPolicyName)(describeStateMachineCommandOutput);
+        expect(actual).toEqual(`LogsDeliveryAccessPolicy-${fakeStateMachineName}`);
+    });
+});
+//# sourceMappingURL=helpers.test.js.map

package/dist/commands/stepfunctions/__tests__/helpers.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.test.js","sourceRoot":"","sources":["../../../../src/commands/stepfunctions/__tests__/helpers.test.ts"],"names":[],"mappings":";;AAAA,oDAA+E;AAE/E,wCAYmB;AAEnB,4DAAoE;AAEpE,QAAQ,CAAC,qCAAqC,EAAE,GAAG,EAAE;IACnD,QAAQ,CAAC,uCAAuC,EAAE,GAAG,EAAE;QACrD,IAAI,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACxD,MAAM,IAAI,GAAa;gBACrB,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE,gCAAgC;gBAC1C,UAAU,EAAE;oBACV,YAAY,EAAE,0EAA0E;oBACxF,WAAW,EAAE,gCAAgC;iBAC9C;gBACD,GAAG,EAAE,IAAI;aACV,CAAA;YACD,MAAM,CAAC,IAAA,0CAAgC,EAAC,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE,CAAA;QAC5D,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,kBAAkB,EAAE,GAAG,EAAE;YAC5B,MAAM,IAAI,GAAa;gBACrB,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE,gCAAgC;gBAC1C,UAAU,EAAE;oBACV,YAAY,EAAE,0EAA0E;iBACzF;gBACD,GAAG,EAAE,IAAI;aACV,CAAA;YACD,MAAM,CAAC,IAAA,0CAAgC,EAAC,IAAI,CAAC,CAAC,CAAC,UAAU,EAAE,CAAA;QAC7D,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,4BAA4B,EAAE,GAAG,EAAE;YACtC,MAAM,IAAI,GAAa;gBACrB,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE,gCAAgC;gBAC1C,UAAU,EAAE;oBACV,YAAY,EAAE,0EAA0E;oBACxF,WAAW,EAAE,GAAG;iBACjB;gBACD,GAAG,EAAE,IAAI;aACV,CAAA;YACD,MAAM,CAAC,IAAA,0CAAgC,EAAC,IAAI,CAAC,CAAC,CAAC,UAAU,EAAE,CAAA;QAC7D,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAClD,MAAM,IAAI,GAAa;gBACrB,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE,sCAAsC;gBAChD,UAAU,EAAE;oBACV,SAAS,EAAE,sDAAsD;iBAClE;gBACD,GAAG,EAAE,IAAI;aACV,CAAA;YACD,MAAM,CAAC,IAAA,0CAAgC,EAAC,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE,CAAA;QAC5D,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACnD,MAAM,IAAI,GAAa;gBACrB,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE,+DAA+D;gBACzE,GAAG,EAAE,IAAI;aACV,CAAA;YACD,MAAM,CAAC,IAAA,0CAAgC,EAAC,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE,CAAA;QAC5D,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;QACxB,IAAI,CAAC,sBAAsB,EAAE,GAAG,EAAE;YAChC,MAAM,SAAS,GAAG,KAAK,CAAA;YACvB,MAAM,OAAO,GAAG,MAAM,CAAA;YACtB,MAAM,MAAM,GAAG,WAAW,CAAA;YAC1B,MAAM,SAAS,GAAG,cAAc,CAAA;YAChC,MAAM,YAAY,GAAG,WAAW,CAAA;YAChC,MAAM,UAAU,GAAG,wDAAwD,CAAA;YAC3E,MAAM,WAAW,GAAG,IAAA,kBAAQ,EAAC,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,UAAU,CAAC,CAAA;YAE7F,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CACtB,sGAAsG,CACvG,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,IAAI,CAAC,wDAAwD,EAAE,GAAG,EAAE;YAClE,MAAM,YAAY,GAAG,IAAA,2CAA2B,GAAE,CAAA;YAClD,MAAM,GAAG,GAAG,MAAM,CAAA;YAClB,MAAM,YAAY,GAAG,IAAA,2BAAiB,EAAC,YAAY,CAAC,IAAK,EAAE,GAAG,CAAC,CAAA;YAE/D,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAA;QACnF,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACrE,MAAM,YAAY,GAAG,IAAA,2CAA2B,GAAE,CAAA;YAClD,IAAI,GAAG,CAAA;YACP,MAAM,YAAY,GAAG,IAAA,2BAAiB,EAAC,YAAY,CAAC,IAAK,EAAE,GAAG,CAAC,CAAA;YAC/D,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,iDAAiD,CAAC,CAAA;QAC9E,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;QAC3C,IAAI,CAAC,yDAAyD,EAAE,GAAG,EAAE;YACnE,MAAM,YAAY,GAAG,IAAA,2CAA2B,GAAE,CAAA;YAClD,MAAM,sBAAsB,GAAG,IAAA,qCAA2B,EAAC,YAAY,CAAC,IAAK,CAAC,CAAA;YAE9E,MAAM,CAAC,sBAAsB,CAAC,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAA;QACrF,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;YACpD,MAAM,YAAY,GAAG,IAAA,2CAA2B,GAAE,CAAA;YAElD,MAAM,CAAC,IAAA,oBAAU,EAAC,YAAY,CAAC,eAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC9D,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACtD,MAAM,iBAAiB,GAAG,iEAAiE,CAAA;YAE3F,MAAM,CAAC,IAAA,oBAAU,EAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClD,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,+BAA+B,EAAE,GAAG,EAAE;YACzC,MAAM,GAAG,GAAG,EAAE,CAAA;YAEd,MAAM,CAAC,IAAA,oBAAU,EAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACrC,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;QAC1C,IAAI,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC9D,MAAM,YAAY,GAAG,IAAA,2CAA2B,GAAE,CAAA;YAClD,MAAM,WAAW,GAAG,IAAA,oCAA0B,EAAC,YAAY,CAAC,CAAA;YAE5D,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CACtB,sGAAsG,CACvG,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC/D,MAAM,oBAAoB,GAAG;gBAC3B,KAAK,EAAE,qBAAQ,CAAC,GAAG;gBACnB,oBAAoB,EAAE,KAAK;aAC5B,CAAA;YACD,MAAM,YAAY,GAAG,IAAA,2CAA2B,EAAC,EAAC,oBAAoB,EAAC,CAAC,CAAA;YACxE,MAAM,WAAW,GAAG,IAAA,oCAA0B,EAAC,YAAY,CAAC,CAAA;YAE5D,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACrC,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;QACxB,IAAI,CAAC,0BAA0B,EAAE,GAAG,EAAE;YACpC,MAAM,YAAY,GAAG,IAAA,2CAA2B,GAAE,CAAA;YAClD,MAAM,SAAS,GAAG,IAAA,kBAAQ,EAAC,YAAY,CAAC,eAAgB,CAAC,CAAA;YAEzD,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACvC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;YAC1C,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;YAChD,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;QAC5D,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,iDAAiD,EAAE,GAAG,EAAE;QAC/D,IAAI,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACvC,MAAM,IAAI,GAAa;gBACrB,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE,+CAA+C;gBACzD,UAAU,EAAE;oBACV,eAAe,EAAE,8EAA8E;oBAC/F,KAAK,EAAE,EAAE;iBACV;gBACD,GAAG,EAAE,IAAI;aACV,CAAA;YACD,MAAM,CAAC,IAAA,yDAA+C,EAAC,IAAI,CAAC,CAAC,CAAC,UAAU,EAAE,CAAA;QAC5E,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,uBAAuB,EAAE,GAAG,EAAE;YACjC,MAAM,IAAI,GAAa;gBACrB,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE,+CAA+C;gBACzD,UAAU,EAAE;oBACV,eAAe,EAAE,8EAA8E;iBAChG;gBACD,GAAG,EAAE,IAAI;aACV,CAAA;YACD,MAAM,CAAC,IAAA,yDAA+C,EAAC,IAAI,CAAC,CAAC,CAAC,UAAU,EAAE,CAAA;QAC5E,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,8DAA8D,EAAE,GAAG,EAAE;YACxE,MAAM,IAAI,GAAa;gBACrB,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE,+CAA+C;gBACzD,UAAU,EAAE;oBACV,eAAe,EAAE,8EAA8E;oBAC/F,KAAK,EAAE,EAAC,WAAW,EAAE,MAAM,EAAC;iBAC7B;gBACD,GAAG,EAAE,IAAI;aACV,CAAA;YACD,MAAM,CAAC,IAAA,yDAA+C,EAAC,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE,CAAA;QAC3E,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAChD,IAAI,CAAC,iDAAiD,EAAE,GAAG,EAAE;;YAC3D,MAAM,IAAI,GAAa;gBACrB,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE,+CAA+C;gBACzD,UAAU,EAAE;oBACV,eAAe,EAAE,8EAA8E;oBAC/F,KAAK,EAAE,EAAE;iBACV;gBACD,GAAG,EAAE,IAAI;aACV,CAAA;YAED,MAAM,OAAO,GAAG,IAAA,uCAA6B,EAAC,IAAI,CAAC,CAAA;YACnD,MAAM,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,CAAA;YAC5B,MAAM,CAAC,MAAA,IAAI,CAAC,UAAU,0CAAE,KAAK,CAAC,CAAC,OAAO,CAAC,EAAC,WAAW,EAAE,gCAAgC,EAAC,CAAC,CAAA;QACzF,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACzC,MAAM,oBAAoB,GAAG,sBAAsB,CAAA;QACnD,MAAM,iCAAiC,GAAsC;YAC3E,SAAS,EAAE,EAAE;YACb,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,SAAS;YACrB,OAAO,EAAE,SAAS;YAClB,IAAI,EAAE,SAAS;YACf,eAAe,EAAE,qBAAqB;YACtC,IAAI,EAAE,oBAAoB;SAC3B,CAAA;QACD,MAAM,MAAM,GAAG,IAAA,kCAAwB,EAAC,iCAAiC,CAAC,CAAA;QAC1E,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,4BAA4B,oBAAoB,EAAE,CAAC,CAAA;IAC5E,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/commands/stepfunctions/__tests__/instrument.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/commands/stepfunctions/__tests__/instrument.test.js

@@ -0,0 +1,431 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const client_sfn_1 = require("@aws-sdk/client-sfn");
+const advanced_1 = require("clipanion/lib/advanced");
+const instrument_1 = require("../instrument");
+const aws_resources_1 = require("./fixtures/aws-resources");
+const cli_1 = require("./fixtures/cli");
+jest.mock('../../../../package.json', () => ({ version: '2.0.0' }));
+describe('stepfunctions instrument test', () => {
+    let aws;
+    let cli;
+    let context;
+    let helpers;
+    beforeAll(() => {
+        aws = require('../awsCommands');
+        helpers = require('../helpers');
+        helpers.applyChanges = jest.fn().mockImplementation(() => false);
+        helpers.injectContextIntoTasks = jest.fn().mockImplementation();
+        cli = new advanced_1.Cli();
+        cli.register(instrument_1.InstrumentStepFunctionsCommand);
+    });
+    beforeEach(() => {
+        context = (0, cli_1.contextFixture)();
+        const describeStateMachineCommandOutput = (0, aws_resources_1.describeStateMachineFixture)();
+        aws.describeStateMachine = jest.fn().mockImplementation(() => describeStateMachineCommandOutput);
+        const stepFunctionTagList = [{ key: 'env', value: 'test' }];
+        aws.listTagsForResource = jest.fn().mockImplementation(() => ({ tags: stepFunctionTagList }));
+        aws.tagResource = jest.fn().mockImplementation(() => ({}));
+        aws.createLogGroup = jest.fn().mockImplementation(() => ({}));
+        aws.putSubscriptionFilter = jest.fn().mockImplementation(() => ({}));
+        aws.createLogsAccessPolicy = jest.fn().mockImplementation(() => ({}));
+        aws.attachPolicyToStateMachineIamRole = jest.fn().mockImplementation(() => ({}));
+        aws.enableStepFunctionLogs = jest.fn().mockImplementation(() => ({}));
+        aws.putSubscriptionFilter = jest.fn().mockImplementation(() => ({}));
+    });
+    describe('parameter validation', () => {
+        test('errors if forwarder arn is not set', () => __awaiter(void 0, void 0, void 0, function* () {
+            const exitCode = yield cli.run(['stepfunctions', 'instrument'], context);
+            expect(exitCode).toBe(1);
+            expect(context.toString()).toMatch('[Error] `--forwarder` is required');
+        }));
+        test('errors if forwarder arn is invalid', () => __awaiter(void 0, void 0, void 0, function* () {
+            const exitCode = yield cli.run(['stepfunctions', 'instrument', '--forwarder', 'bla:'], context);
+            expect(exitCode).toBe(1);
+            expect(context.toString()).toMatch('[Error] Invalid arn format for `--forwarder` bla:\n');
+        }));
+        test('errors if no step function arn', () => __awaiter(void 0, void 0, void 0, function* () {
+            const exitCode = yield cli.run(['stepfunctions', 'instrument', '--forwarder', 'arn:aws:lambda:sa-east-1:601427279990:function:hello'], context);
+            expect(exitCode).toBe(1);
+            expect(context.toString()).toMatch('[Error] Must specify at least one `--step-function`');
+        }));
+        test('errors if any step function arn is invalid', () => __awaiter(void 0, void 0, void 0, function* () {
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:sa-east-1:601427279990:function:hello',
+                '--step-function',
+                'bla',
+            ], context);
+            expect(exitCode).toBe(1);
+            expect(context.toString()).toMatch('[Error] Invalid arn format for `--step-function` bla');
+        }));
+        test('errors if no env tag on step function and env parameter not set', () => __awaiter(void 0, void 0, void 0, function* () {
+            aws.listTagsForResource = jest.fn().mockImplementation(() => ({ tags: [] }));
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+            ], context);
+            expect(exitCode).toBe(1);
+            expect(context.toString()).toMatch('[Error] --env is required when a Step Function has no env tag');
+        }));
+    });
+    describe('stepfunctions command overall test', () => {
+        test('all aws commands are called when log level is OFF', () => __awaiter(void 0, void 0, void 0, function* () {
+            const loggingConfiguration = {
+                level: client_sfn_1.LogLevel.OFF,
+                includeExecutionData: false,
+            };
+            const describeStateMachineCommandOutput = (0, aws_resources_1.describeStateMachineFixture)({ loggingConfiguration });
+            aws.describeStateMachine = jest.fn().mockImplementation(() => describeStateMachineCommandOutput);
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+                '--env',
+                'test',
+            ], context);
+            expect(aws.describeStateMachine).toHaveBeenCalledTimes(1);
+            expect(aws.listTagsForResource).toHaveBeenCalledTimes(1);
+            expect(aws.tagResource).toHaveBeenCalledTimes(1);
+            expect(aws.createLogGroup).toHaveBeenCalledTimes(1);
+            expect(aws.putSubscriptionFilter).toHaveBeenCalledTimes(1);
+            expect(aws.createLogsAccessPolicy).toHaveBeenCalledTimes(1);
+            expect(aws.attachPolicyToStateMachineIamRole).toHaveBeenCalledTimes(1);
+            expect(aws.enableStepFunctionLogs).toHaveBeenCalledTimes(1);
+            expect(aws.putSubscriptionFilter).toHaveBeenCalledTimes(1);
+            expect(exitCode).toBe(0);
+        }));
+        test('all aws commands are called the same times when as log-level-off state machines', () => __awaiter(void 0, void 0, void 0, function* () {
+            const loggingConfiguration = {
+                level: client_sfn_1.LogLevel.OFF,
+                includeExecutionData: false,
+            };
+            const describeStateMachineCommandOutput = (0, aws_resources_1.describeStateMachineFixture)({ loggingConfiguration });
+            aws.describeStateMachine = jest.fn().mockImplementation(() => describeStateMachineCommandOutput);
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction222',
+                '--env',
+                'test',
+            ], context);
+            expect(aws.describeStateMachine).toHaveBeenCalledTimes(2);
+            expect(aws.listTagsForResource).toHaveBeenCalledTimes(2);
+            expect(aws.tagResource).toHaveBeenCalledTimes(2);
+            expect(aws.createLogGroup).toHaveBeenCalledTimes(2);
+            expect(aws.putSubscriptionFilter).toHaveBeenCalledTimes(2);
+            expect(aws.createLogsAccessPolicy).toHaveBeenCalledTimes(2);
+            expect(aws.attachPolicyToStateMachineIamRole).toHaveBeenCalledTimes(2);
+            expect(aws.enableStepFunctionLogs).toHaveBeenCalledTimes(2);
+            expect(aws.putSubscriptionFilter).toHaveBeenCalledTimes(2);
+            expect(exitCode).toBe(0);
+        }));
+        test('removes duplicate step function arns', () => __awaiter(void 0, void 0, void 0, function* () {
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+            ], context);
+            expect(exitCode).toBe(0);
+            expect(aws.describeStateMachine).toHaveBeenCalledTimes(1);
+        }));
+    });
+    describe('step function tags', () => {
+        test('sets dd_sls_ci tag if not already set', () => __awaiter(void 0, void 0, void 0, function* () {
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+                '--env',
+                'test',
+            ], context);
+            expect(exitCode).toBe(0);
+            expect(aws.tagResource).toHaveBeenCalledTimes(1);
+        }));
+        test('sets dd_sls_ci tag if changed', () => __awaiter(void 0, void 0, void 0, function* () {
+            const stepFunctionTagList = (0, aws_resources_1.stepFunctionTagListFixture)([{ key: 'dd_sls_ci', value: 'v1.0.0' }]);
+            aws.listTagsForResource = jest.fn().mockImplementation(() => ({ tags: stepFunctionTagList }));
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+                '--env',
+                'test',
+            ], context);
+            expect(exitCode).toBe(0);
+            expect(aws.tagResource).toHaveBeenCalledTimes(1);
+        }));
+        test('sets env tag if not already set', () => __awaiter(void 0, void 0, void 0, function* () {
+            aws.listTagsForResource = jest.fn().mockImplementation(() => ({ tags: [{ key: 'dd_sls_ci', value: 'v2.0.0' }] }));
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+                '--env',
+                'test',
+            ], context);
+            expect(exitCode).toBe(0);
+            expect(aws.tagResource).toHaveBeenCalledTimes(1);
+        }));
+        test('sets service tag if not already set', () => __awaiter(void 0, void 0, void 0, function* () {
+            const stepFunctionTagList = (0, aws_resources_1.stepFunctionTagListFixture)([{ key: 'dd_sls_ci', value: 'v2.0.0' }]);
+            aws.listTagsForResource = jest.fn().mockImplementation(() => ({ tags: stepFunctionTagList }));
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+                '--env',
+                'test',
+                '--service',
+                'test-service',
+            ], context);
+            expect(exitCode).toBe(0);
+            expect(aws.tagResource).toHaveBeenCalledTimes(1);
+        }));
+    });
+    describe('step function logging disabled', () => {
+        test('creates step function log group, subscribes it to forwarder, and adds it to step function logging config', () => __awaiter(void 0, void 0, void 0, function* () {
+            const loggingConfiguration = {
+                level: client_sfn_1.LogLevel.OFF,
+                includeExecutionData: false,
+            };
+            const stepFunction = (0, aws_resources_1.describeStateMachineFixture)({ loggingConfiguration });
+            aws.describeStateMachine = jest.fn().mockImplementation(() => stepFunction);
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+            ], context);
+            expect(aws.describeStateMachine).toHaveBeenCalledTimes(1);
+            expect(aws.listTagsForResource).toHaveBeenCalledTimes(1);
+            expect(aws.tagResource).toHaveBeenCalledTimes(1);
+            expect(aws.createLogGroup).toHaveBeenCalledTimes(1);
+            expect(aws.putSubscriptionFilter).toHaveBeenCalledTimes(1);
+            expect(aws.createLogsAccessPolicy).toHaveBeenCalledTimes(1);
+            expect(aws.attachPolicyToStateMachineIamRole).toHaveBeenCalledTimes(1);
+            expect(aws.enableStepFunctionLogs).toHaveBeenCalledTimes(1);
+            expect(aws.putSubscriptionFilter).toHaveBeenCalledTimes(1);
+            expect(exitCode).toBe(0);
+        }));
+    });
+    describe('step function logging enabled', () => {
+        test('subscribes log group in step function logging config to forwarder', () => __awaiter(void 0, void 0, void 0, function* () {
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+            ], context);
+            expect(aws.describeStateMachine).toHaveBeenCalledTimes(1);
+            expect(aws.listTagsForResource).toHaveBeenCalledTimes(1);
+            expect(aws.tagResource).toHaveBeenCalledTimes(1);
+            expect(aws.createLogGroup).toHaveBeenCalledTimes(0);
+            expect(aws.createLogsAccessPolicy).toHaveBeenCalledTimes(0);
+            expect(aws.attachPolicyToStateMachineIamRole).toHaveBeenCalledTimes(0);
+            expect(aws.enableStepFunctionLogs).toHaveBeenCalledTimes(0); // already has logging properly set
+            expect(aws.putSubscriptionFilter).toHaveBeenCalledTimes(1);
+            expect(exitCode).toBe(0);
+        }));
+        test('log level is not ALL, should call enableStepFunctionLogs', () => __awaiter(void 0, void 0, void 0, function* () {
+            const loggingConfiguration = {
+                level: client_sfn_1.LogLevel.FATAL,
+                includeExecutionData: true,
+                destinations: [
+                    {
+                        cloudWatchLogsLogGroup: {
+                            logGroupArn: 'arn:aws:logs:us-east-1:000000000000:log-group:/aws/vendedlogs/states/ExampleStepFunction-Logs-test:*',
+                        },
+                    },
+                ],
+            };
+            const describeStateMachineCommandOutput = (0, aws_resources_1.describeStateMachineFixture)({ loggingConfiguration });
+            aws.describeStateMachine = jest.fn().mockImplementation(() => describeStateMachineCommandOutput);
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+            ], context);
+            expect(aws.describeStateMachine).toHaveBeenCalledTimes(1);
+            expect(aws.listTagsForResource).toHaveBeenCalledTimes(1);
+            expect(aws.tagResource).toHaveBeenCalledTimes(1);
+            expect(aws.createLogGroup).toHaveBeenCalledTimes(0);
+            expect(aws.createLogsAccessPolicy).toHaveBeenCalledTimes(0);
+            expect(aws.attachPolicyToStateMachineIamRole).toHaveBeenCalledTimes(0);
+            expect(aws.enableStepFunctionLogs).toHaveBeenCalledTimes(1);
+            expect(aws.putSubscriptionFilter).toHaveBeenCalledTimes(1);
+            expect(exitCode).toBe(0);
+        }));
+        test('log level is ALL but includeExecutionData is false. Should call enableStepFunctionLogs', () => __awaiter(void 0, void 0, void 0, function* () {
+            const loggingConfiguration = {
+                level: client_sfn_1.LogLevel.ALL,
+                includeExecutionData: false,
+                destinations: [
+                    {
+                        cloudWatchLogsLogGroup: {
+                            logGroupArn: 'arn:aws:logs:us-east-1:000000000000:log-group:/aws/vendedlogs/states/ExampleStepFunction-Logs-test:*',
+                        },
+                    },
+                ],
+            };
+            const describeStateMachineCommandOutput = (0, aws_resources_1.describeStateMachineFixture)({ loggingConfiguration });
+            aws.describeStateMachine = jest.fn().mockImplementation(() => describeStateMachineCommandOutput);
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+            ], context);
+            expect(aws.describeStateMachine).toHaveBeenCalledTimes(1);
+            expect(aws.listTagsForResource).toHaveBeenCalledTimes(1);
+            expect(aws.tagResource).toHaveBeenCalledTimes(1);
+            expect(aws.createLogGroup).toHaveBeenCalledTimes(0);
+            expect(aws.createLogsAccessPolicy).toHaveBeenCalledTimes(0);
+            expect(aws.attachPolicyToStateMachineIamRole).toHaveBeenCalledTimes(0);
+            expect(aws.enableStepFunctionLogs).toHaveBeenCalledTimes(1);
+            expect(aws.putSubscriptionFilter).toHaveBeenCalledTimes(1);
+            expect(exitCode).toBe(0);
+        }));
+        test('log level is not ALL but includeExecutionData is false. Should call enableStepFunctionLogs', () => __awaiter(void 0, void 0, void 0, function* () {
+            const loggingConfiguration = {
+                level: client_sfn_1.LogLevel.FATAL,
+                includeExecutionData: false,
+                destinations: [
+                    {
+                        cloudWatchLogsLogGroup: {
+                            logGroupArn: 'arn:aws:logs:us-east-1:000000000000:log-group:/aws/vendedlogs/states/ExampleStepFunction-Logs-test:*',
+                        },
+                    },
+                ],
+            };
+            const describeStateMachineCommandOutput = (0, aws_resources_1.describeStateMachineFixture)({ loggingConfiguration });
+            aws.describeStateMachine = jest.fn().mockImplementation(() => describeStateMachineCommandOutput);
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+            ], context);
+            expect(aws.describeStateMachine).toHaveBeenCalledTimes(1);
+            expect(aws.listTagsForResource).toHaveBeenCalledTimes(1);
+            expect(aws.tagResource).toHaveBeenCalledTimes(1);
+            expect(aws.createLogGroup).toHaveBeenCalledTimes(0);
+            expect(aws.createLogsAccessPolicy).toHaveBeenCalledTimes(0);
+            expect(aws.attachPolicyToStateMachineIamRole).toHaveBeenCalledTimes(0);
+            expect(aws.enableStepFunctionLogs).toHaveBeenCalledTimes(1);
+            expect(aws.putSubscriptionFilter).toHaveBeenCalledTimes(1);
+            expect(exitCode).toBe(0);
+        }));
+    });
+    describe('mergeStepFunctionAndLambdaTraces enabled', () => {
+        test('mergeStepFunctionAndLambdaTraces flag is set (to true)', () => __awaiter(void 0, void 0, void 0, function* () {
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+                '--merge-lambda-traces',
+            ], context);
+            expect(helpers.injectContextIntoTasks).toHaveBeenCalledTimes(1);
+            expect(exitCode).toBe(0);
+        }));
+        test('mergeStepFunctionAndLambdaTraces flag is not set (default to false)', () => __awaiter(void 0, void 0, void 0, function* () {
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+            ], context);
+            expect(helpers.injectContextIntoTasks).toHaveBeenCalledTimes(0);
+            expect(exitCode).toBe(0);
+        }));
+    });
+    describe('aws error handling', () => {
+        test('errors if unable to fetch step function', () => __awaiter(void 0, void 0, void 0, function* () {
+            aws.describeStateMachine = jest.fn().mockImplementation(() => {
+                throw new Error('mock describeStateMachine error');
+            });
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+            ], context);
+            expect(exitCode).toBe(1);
+            expect(context.toString()).toMatch('[Error] mock describeStateMachine error. Unable to describe state machine arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction');
+        }));
+        test('errors if unable to fetch step function tags', () => __awaiter(void 0, void 0, void 0, function* () {
+            aws.listTagsForResource = jest.fn().mockImplementation(() => {
+                throw new Error('mock listTagsForResource error');
+            });
+            const exitCode = yield cli.run([
+                'stepfunctions',
+                'instrument',
+                '--forwarder',
+                'arn:aws:lambda:us-east-1:000000000000:function:DatadogForwarder',
+                '--step-function',
+                'arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction',
+            ], context);
+            expect(exitCode).toBe(1);
+            expect(context.toString()).toMatch('[Error] mock listTagsForResource error. Unable to fetch tags for Step Function arn:aws:states:us-east-1:000000000000:stateMachine:ExampleStepFunction');
+        }));
+    });
+});
+//# sourceMappingURL=instrument.test.js.map