Merge pull request #3453 from snyk/feat/iac-test-add-remote-repo-url-…

…flag

feat: add --remote-repo-url to "iac test"

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

@@ -13,13 +13,15 @@ import config from '../../../../lib/config';
 import { UnsupportedEntitlementError } from '../../../../lib/errors/unsupported-entitlement-error';
 import { scan } from './scan';
 import { buildOutput, buildSpinner, printHeader } from './output';
+import { InvalidRemoteUrlError } from '../../../../lib/errors/invalid-remote-url-error';
 
 export default async function(...args: MethodArgs): Promise<TestCommandResult> {
   const { options: originalOptions, paths } = processCommandArgs(...args);
 
   const options = setDefaultTestOptions(originalOptions);
   validateTestOptions(options);
   validateCredentials(options);
+  const remoteRepoUrl = getRemoteRepoUrl(options);
 
   const orgPublicId = (options.org as string) ?? config.org;
   const iacOrgSettings = await getIacOrgSettings(orgPublicId);
@@ -69,6 +71,7 @@ export default async function(...args: MethodArgs): Promise<TestCommandResult> {
     orgPublicId,
     buildOciRegistry,
     projectRoot,
+    remoteRepoUrl,
   );
 
   return buildOutput({
@@ -84,3 +87,17 @@ export default async function(...args: MethodArgs): Promise<TestCommandResult> {
     testSpinner,
   });
 }
+
+function getRemoteRepoUrl(options: any) {
+  const remoteRepoUrl = options['remote-repo-url'];
+
+  if (!remoteRepoUrl) {
+    return;
+  }
+
+  if (typeof remoteRepoUrl !== 'string') {
+    throw new InvalidRemoteUrlError();
+  }
+
+  return remoteRepoUrl;
+}

src/cli/commands/test/iac/local-execution/assert-iac-options-flag.ts

@@ -33,6 +33,7 @@ const keys: (keyof IaCTestFlags)[] = [
   // PolicyOptions
   'ignore-policy',
   'policy-path',
+  'remote-repo-url',
 ];
 const allowed = new Set<string>(keys);
 

src/cli/commands/test/iac/local-execution/process-results/cli-share-results.ts

@@ -8,42 +8,41 @@ import {
 } from '../types';
 import { convertIacResultToScanResult } from '../../../../../../lib/iac/envelope-formatters';
 import { Policy } from '../../../../../../lib/policy/find-and-load-policy';
-import { getInfo } from '../../../../../../lib/project-metadata/target-builders/git';
-import { GitTarget } from '../../../../../../lib/ecosystems/types';
-import { Contributor } from '../../../../../../lib/types';
+import {
+  Contributor,
+  IacOutputMeta,
+  ProjectAttributes,
+  Tag,
+} from '../../../../../../lib/types';
 import * as analytics from '../../../../../../lib/analytics';
 import { getContributors } from '../../../../../../lib/monitor/dev-count-analysis';
 import * as Debug from 'debug';
 import { AuthFailedError, ValidationError } from '../../../../../../lib/errors';
-import * as pathLib from 'path';
+import { TestLimitReachedError } from '../usage-tracking';
 
 const debug = Debug('iac-cli-share-results');
-import { ProjectAttributes, Tag } from '../../../../../../lib/types';
-import { TestLimitReachedError } from '../usage-tracking';
-import { getRepositoryRootForPath } from '../../../../../../lib/iac/git';
 
 export async function shareResults({
   results,
   policy,
   tags,
   attributes,
   options,
-  projectRoot,
+  meta,
 }: {
   results: IacShareResultsFormat[];
   policy: Policy | undefined;
   tags?: Tag[];
   attributes?: ProjectAttributes;
   options?: IaCTestFlags;
-  projectRoot: string;
+  meta: IacOutputMeta;
 }): Promise<ShareResultsOutput> {
-  const gitTarget = await readGitInfoForProjectRoot(projectRoot);
   const scanResults = results.map((result) =>
-    convertIacResultToScanResult(result, policy, gitTarget, options),
+    convertIacResultToScanResult(result, policy, meta, options),
   );
 
   let contributors: Contributor[] = [];
-  if (gitTarget.remoteUrl) {
+  if (meta.gitRemoteUrl) {
     if (analytics.allowAnalytics()) {
       try {
         contributors = await getContributors();
@@ -79,29 +78,5 @@ export async function shareResults({
     );
   }
 
-  return { projectPublicIds: body, gitRemoteUrl: gitTarget?.remoteUrl };
-}
-
-async function readGitInfoForProjectRoot(
-  projectRoot: string,
-): Promise<GitTarget> {
-  const repositoryRoot = getRepositoryRootForPath(projectRoot);
-
-  const resolvedRepositoryRoot = pathLib.resolve(repositoryRoot);
-  const resolvedProjectRoot = pathLib.resolve(projectRoot);
-
-  if (resolvedRepositoryRoot != resolvedProjectRoot) {
-    return {};
-  }
-
-  const gitInfo = await getInfo({
-    isFromContainer: false,
-    cwd: projectRoot,
-  });
-
-  if (gitInfo) {
-    return gitInfo;
-  }
-
-  return {};
+  return { projectPublicIds: body, gitRemoteUrl: meta.gitRemoteUrl };
 }

src/cli/commands/test/iac/local-execution/process-results/index.ts

@@ -1,5 +1,9 @@
 import { Policy } from '../../../../../../lib/policy/find-and-load-policy';
-import { ProjectAttributes, Tag } from '../../../../../../lib/types';
+import {
+  IacOutputMeta,
+  ProjectAttributes,
+  Tag,
+} from '../../../../../../lib/types';
 import {
   FormattedResult,
   IacFileScanResult,
@@ -26,6 +30,7 @@ export class SingleGroupResultsProcessor implements ResultsProcessor {
     private orgPublicId: string,
     private iacOrgSettings: IacOrgSettings,
     private options: IaCTestFlags,
+    private meta: IacOutputMeta,
   ) {}
 
   processResults(
@@ -43,6 +48,7 @@ export class SingleGroupResultsProcessor implements ResultsProcessor {
       attributes,
       this.options,
       this.projectRoot,
+      this.meta,
     );
   }
 }

src/cli/commands/test/iac/local-execution/process-results/process-results.ts

@@ -2,7 +2,11 @@ import { filterIgnoredIssues } from './policy';
 import { formatAndShareResults } from './share-results';
 import { formatScanResultsV2 } from '../measurable-methods';
 import { Policy } from '../../../../../../lib/policy/find-and-load-policy';
-import { ProjectAttributes, Tag } from '../../../../../../lib/types';
+import {
+  IacOutputMeta,
+  ProjectAttributes,
+  Tag,
+} from '../../../../../../lib/types';
 import {
   FormattedResult,
   IacFileScanResult,
@@ -19,6 +23,7 @@ export async function processResults(
   attributes: ProjectAttributes | undefined,
   options: IaCTestFlags,
   projectRoot: string,
+  meta: IacOutputMeta,
 ): Promise<{
   filteredIssues: FormattedResult[];
   ignoreCount: number;
@@ -35,6 +40,7 @@ export async function processResults(
       tags,
       attributes,
       projectRoot,
+      meta,
     }));
   }
 

src/cli/commands/test/iac/local-execution/process-results/share-results-formatter.ts

@@ -1,16 +1,19 @@
 import { IacFileScanResult, IacShareResultsFormat } from '../types';
 import * as path from 'path';
+import { IacOutputMeta } from '../../../../../../lib/types';
 
 export function formatShareResults(
   projectRoot: string,
   scanResults: IacFileScanResult[],
+  meta: IacOutputMeta,
 ): IacShareResultsFormat[] {
   const resultsGroupedByFilePath = groupByFilePath(scanResults);
 
   return resultsGroupedByFilePath.map((result) => {
     const { projectName, targetFile } = computePaths(
       projectRoot,
       result.filePath,
+      meta,
     );
 
     return {
@@ -45,16 +48,16 @@ function groupByFilePath(scanResults: IacFileScanResult[]) {
 function computePaths(
   projectRoot: string,
   filePath: string,
+  meta: IacOutputMeta,
 ): { targetFilePath: string; projectName: string; targetFile: string } {
   const projectDirectory = path.resolve(projectRoot);
-  const currentDirectoryName = path.basename(projectDirectory);
   const absoluteFilePath = path.resolve(filePath);
   const relativeFilePath = path.relative(projectDirectory, absoluteFilePath);
   const unixRelativeFilePath = relativeFilePath.split(path.sep).join('/');
 
   return {
     targetFilePath: absoluteFilePath,
-    projectName: currentDirectoryName,
+    projectName: meta.projectName,
     targetFile: unixRelativeFilePath,
   };
 }

src/cli/commands/test/iac/local-execution/process-results/share-results.ts

@@ -1,7 +1,11 @@
 import { isFeatureFlagSupportedForOrg } from '../../../../../../lib/feature-flags';
 import { shareResults } from './cli-share-results';
 import { Policy } from '../../../../../../lib/policy/find-and-load-policy';
-import { ProjectAttributes, Tag } from '../../../../../../lib/types';
+import {
+  IacOutputMeta,
+  ProjectAttributes,
+  Tag,
+} from '../../../../../../lib/types';
 import { FeatureFlagError } from '../assert-iac-options-flag';
 import { formatShareResults } from './share-results-formatter';
 import { IacFileScanResult, IaCTestFlags, ShareResultsOutput } from '../types';
@@ -14,6 +18,7 @@ export async function formatAndShareResults({
   tags,
   attributes,
   projectRoot,
+  meta,
 }: {
   results: IacFileScanResult[];
   options: IaCTestFlags;
@@ -22,6 +27,7 @@ export async function formatAndShareResults({
   tags?: Tag[];
   attributes?: ProjectAttributes;
   projectRoot: string;
+  meta: IacOutputMeta;
 }): Promise<ShareResultsOutput> {
   const isCliReportEnabled = await isFeatureFlagSupportedForOrg(
     'iacCliShareResults',
@@ -31,14 +37,14 @@ export async function formatAndShareResults({
     throw new FeatureFlagError('report', 'iacCliShareResults');
   }
 
-  const formattedResults = formatShareResults(projectRoot, results);
+  const formattedResults = formatShareResults(projectRoot, results, meta);
 
   return await shareResults({
     results: formattedResults,
     policy,
     tags,
     attributes,
     options,
-    projectRoot,
+    meta,
   });
 }

src/cli/commands/test/iac/local-execution/types.ts

@@ -186,6 +186,7 @@ export type IaCTestFlags = Pick<
   | 'ignore-policy'
   | 'policy-path'
   | 'tags'
+  | 'remote-repo-url'
 > & {
   // Supported flags not yet covered by Options or TestOptions
   'json-file-output'?: string;

src/cli/commands/test/iac/meta.ts

@@ -0,0 +1,86 @@
+import { IacOutputMeta } from '../../../../lib/types';
+import { IacOrgSettings } from './local-execution/types';
+import * as pathLib from 'path';
+
+export interface GitRepository {
+  readonly path: string;
+
+  readRemoteUrl(): Promise<string | undefined>;
+}
+
+export interface GitRepositoryFinder {
+  findRepositoryForPath(path: string): Promise<GitRepository | undefined>;
+}
+
+export async function buildMeta(
+  repositoryFinder: GitRepositoryFinder,
+  orgSettings: IacOrgSettings,
+  projectRoot: string,
+  remoteRepoUrl?: string,
+): Promise<IacOutputMeta> {
+  const gitRemoteUrl = await getGitRemoteUrl(
+    repositoryFinder,
+    projectRoot,
+    remoteRepoUrl,
+  );
+  const projectName = getProjectName(projectRoot, gitRemoteUrl);
+  const orgName = getOrgName(orgSettings);
+  return { projectName, orgName, gitRemoteUrl };
+}
+
+function getProjectName(projectRoot: string, gitRemoteUrl?: string): string {
+  if (gitRemoteUrl) {
+    return getProjectNameFromGitUrl(gitRemoteUrl);
+  }
+
+  return pathLib.basename(pathLib.resolve(projectRoot));
+}
+
+function getOrgName(orgSettings: IacOrgSettings): string {
+  return orgSettings.meta.org;
+}
+
+async function getGitRemoteUrl(
+  repositoryFinder: GitRepositoryFinder,
+  projectRoot: string,
+  remoteRepoUrl?: string,
+): Promise<string | undefined> {
+  if (remoteRepoUrl) {
+    return remoteRepoUrl;
+  }
+
+  const repository = await repositoryFinder.findRepositoryForPath(projectRoot);
+
+  if (!repository) {
+    return;
+  }
+
+  const resolvedRepositoryRoot = pathLib.resolve(repository.path);
+  const resolvedProjectRoot = pathLib.resolve(projectRoot);
+
+  if (resolvedRepositoryRoot != resolvedProjectRoot) {
+    return;
+  }
+
+  return await repository.readRemoteUrl();
+}
+
+export function getProjectNameFromGitUrl(url: string) {
+  const regexps = [
+    /^ssh:\/\/([^@]+@)?[^:/]+(:[^/]+)?\/(?<name>.*).git\/?$/,
+    /^(git|https?|ftp):\/\/[^:/]+(:[^/]+)?\/(?<name>.*).git\/?$/,
+    /^[^@]+@[^:]+:(?<name>.*).git$/,
+  ];
+
+  const trimmed = url.trim();
+
+  for (const regexp of regexps) {
+    const match = trimmed.match(regexp);
+
+    if (match && match.groups) {
+      return match.groups.name;
+    }
+  }
+
+  return trimmed;
+}