Merge pull request #3867 from snyk/feat/update-iac-cloud-integrated-ff

feat: Update feature gating for new IaC Integrated experience [CFG-2163, CFG-2168]

src/cli/commands/test/iac/v2/assert-iac-options.ts

@@ -26,7 +26,6 @@ const keys: (keyof IaCTestFlags)[] = [
   'json-file-output',
   'sarif-file-output',
   'scan',
-  'experimental',
   'var-file',
   'detectionDepth',
   'cloud-context',

src/cli/commands/test/iac/v2/index.ts

@@ -14,6 +14,7 @@ import { getFlag } from '../index';
 import { IaCTestFlags } from '../local-execution/types';
 import { findAndLoadPolicy } from '../../../../../lib/policy';
 import { assertIacV2Options } from './assert-iac-options';
+import { UnsupportedEntitlementError } from '../../../../../lib/errors/unsupported-entitlement-error';
 
 export async function test(
   paths: string[],
@@ -23,6 +24,10 @@ export async function test(
   const testConfig = await prepareTestConfig(paths, options);
   const { orgSettings } = testConfig;
 
+  if (!orgSettings.entitlements?.infrastructureAsCode) {
+    throw new UnsupportedEntitlementError('infrastructureAsCode');
+  }
+
   const testSpinner = buildSpinner(options);
 
   printHeader(options);

src/cli/commands/test/index.ts

@@ -58,10 +58,7 @@ export default async function test(
   const options = setDefaultTestOptions(originalOptions);
   if (originalOptions.iac) {
     // temporary placeholder for the "new" flow that integrates with UPE
-    if (
-      (await hasFeatureFlag('iacCliUnifiedEngine', options)) &&
-      options.experimental
-    ) {
+    if (await hasFeatureFlag('iacIntegratedExperience', options)) {
       return await iacTestCommandV2.test(paths, originalOptions);
     } else {
       return await iacTestCommand(...args);

test/acceptance/fake-server.ts

@@ -7,7 +7,10 @@ import * as path from 'path';
 import { getFixturePath } from '../jest/util/getFixturePath';
 
 const featureFlagDefaults = (): Map<string, boolean> => {
-  return new Map([['cliFailFast', false]]);
+  return new Map([
+    ['cliFailFast', false],
+    ['iacIntegratedExperience', false],
+  ]);
 };
 
 export type FakeServer = {

test/jest/unit/cli/commands/test/iac/v2/index.spec.ts

@@ -53,6 +53,9 @@ describe('test', () => {
       isLicensesEnabled: false,
       isPrivate: false,
     },
+    entitlements: {
+      infrastructureAsCode: true,
+    },
   };
 
   const scanFixture = JSON.parse(fs.readFileSync(scanFixturePath, 'utf-8'));

test/jest/unit/iac/process-results/fixtures/input-files-for-snyk-iac-test-fixtures/README.md

@@ -7,7 +7,7 @@ console.log(JSON.stringify(scanResult, null, 2));
 ```
 3. scan the directory by running the following command:
 ```
-snyk-dev iac test --experimental vpc_group.tf plan.json invalid_file.txt
+snyk-dev iac test vpc_group.tf plan.json invalid_file.txt
 ```
 4. save the scan results in the [primary fixture file](../snyk-iac-test-results.json)
 5. start regenerating fixtures like a mad (wo)man!!!

test/jest/unit/lib/iac/test/v2/json.spec.ts

@@ -30,7 +30,7 @@ describe('convertEngineToJsonResults', () => {
     return isError ? new SnykIacTestError(item) : item;
   });
 
-  const experimentalJsonOutputFixtureContent = fs.readFileSync(
+  const integratedJsonOutputFixtureContent = fs.readFileSync(
     path.join(
       __dirname,
       '..',
@@ -40,15 +40,15 @@ describe('convertEngineToJsonResults', () => {
       'iac',
       'process-results',
       'fixtures',
-      'experimental-json-output.json',
+      'integrated-json-output.json',
     ),
     'utf-8',
   );
-  let experimentalJsonOutputFixture: Array<Result | ScanError> = JSON.parse(
-    experimentalJsonOutputFixtureContent,
+  let integratedJsonOutputFixture: Array<Result | ScanError> = JSON.parse(
+    integratedJsonOutputFixtureContent,
   );
 
-  experimentalJsonOutputFixture = experimentalJsonOutputFixture.map((item) =>
+  integratedJsonOutputFixture = integratedJsonOutputFixture.map((item) =>
     !('error' in item) ? { ...item, path: process.cwd() } : item,
   );
 
@@ -75,12 +75,12 @@ describe('convertEngineToJsonResults', () => {
       orgSettings,
     });
 
-    experimentalJsonOutputFixture.forEach((item) => {
+    integratedJsonOutputFixture.forEach((item) => {
       if ('targetFilePath' in item) {
         item.targetFilePath = path.resolve(item.targetFile);
       }
     });
 
-    expect(result).toEqual(experimentalJsonOutputFixture);
+    expect(result).toEqual(integratedJsonOutputFixture);
   });
 });

test/jest/unit/lib/iac/test/v2/sarif.spec.ts

@@ -22,7 +22,7 @@ describe('convertEngineToSarifResults', () => {
   );
   const snykIacTestFixture: TestOutput = JSON.parse(snykIacTestFixtureContent);
 
-  const experimentalSarifOutputFixtureContent = fs.readFileSync(
+  const integratedSarifOutputFixtureContent = fs.readFileSync(
     path.join(
       __dirname,
       '..',
@@ -32,21 +32,21 @@ describe('convertEngineToSarifResults', () => {
       'iac',
       'process-results',
       'fixtures',
-      'experimental-sarif-output.json',
+      'integrated-sarif-output.json',
     ),
     'utf-8',
   );
-  const experimentalSarifOutputFixture: sarif.Log = JSON.parse(
-    experimentalSarifOutputFixtureContent,
+  const integratedSarifOutputFixture: sarif.Log = JSON.parse(
+    integratedSarifOutputFixtureContent,
   );
 
-  experimentalSarifOutputFixture.runs[0].originalUriBaseIds!.PROJECTROOT.uri = pathToFileURL(
+  integratedSarifOutputFixture.runs[0].originalUriBaseIds!.PROJECTROOT.uri = pathToFileURL(
     process.cwd() + '/',
   ).href;
 
   it('returns expected SARIF result', () => {
     const result = convertEngineToSarifResults(snykIacTestFixture);
 
-    expect(result).toEqual(experimentalSarifOutputFixture);
+    expect(result).toEqual(integratedSarifOutputFixture);
   });
 });

test/smoke/iac/test.spec.ts

@@ -2,7 +2,7 @@ import { run } from '../../jest/acceptance/iac/helpers';
 
 jest.setTimeout(1_000 * 90);
 
-describe('snyk iac test --experimental', () => {
+describe('snyk iac test', () => {
   beforeAll(async () => {
     await login();
   });
@@ -12,9 +12,7 @@ describe('snyk iac test --experimental', () => {
     const filePath = 'iac/depth_detection/root.tf';
 
     // Act
-    const { stderr, stdout, exitCode } = await run(
-      `snyk iac test --experimental ${filePath}`,
-    );
+    const { stderr, stdout, exitCode } = await run(`snyk iac test ${filePath}`);
 
     // Assert
     expect(stdout).toContain('Infrastructure as Code');