Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(terraform): use HCL parser and introduce class based extractors (#…
…19269) Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
- Loading branch information
1 parent
817d2d8
commit 1ab049f
Showing
36 changed files
with
948 additions
and
851 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| import is from '@sindresorhus/is'; | ||
| import { regEx } from '../../../util/regex'; | ||
| import { TerraformProviderDatasource } from '../../datasource/terraform-provider'; | ||
| import type { PackageDependency } from '../types'; | ||
| import type { ProviderLock } from './lockfile/types'; | ||
| import { getLockedVersion, massageProviderLookupName } from './util'; | ||
|
|
||
| export abstract class DependencyExtractor { | ||
| /** | ||
| * Get a list of signals which can be used to scan for potential processable content | ||
| * @return a list of content signals | ||
| */ | ||
| abstract getCheckList(): string[]; | ||
|
|
||
| /** | ||
| * Extract dependencies from a HCL object | ||
| * @param hclRoot HCL parsing artifact. | ||
| * @param locks currently existing locks | ||
| */ | ||
| abstract extract(hclRoot: any, locks: ProviderLock[]): PackageDependency[]; | ||
| } | ||
|
|
||
| export abstract class TerraformProviderExtractor extends DependencyExtractor { | ||
| sourceExtractionRegex = regEx( | ||
| /^(?:(?<hostname>(?:[a-zA-Z0-9-_]+\.+)+[a-zA-Z0-9-_]+)\/)?(?:(?<namespace>[^/]+)\/)?(?<type>[^/]+)/ | ||
| ); | ||
|
|
||
| protected analyzeTerraformProvider( | ||
| dep: PackageDependency, | ||
| locks: ProviderLock[], | ||
| depType: string | ||
| ): PackageDependency { | ||
| dep.depType = depType; | ||
| dep.depName = dep.managerData?.moduleName; | ||
| dep.datasource = TerraformProviderDatasource.id; | ||
|
|
||
| if (is.nonEmptyString(dep.managerData?.source)) { | ||
| // TODO #7154 | ||
| const source = this.sourceExtractionRegex.exec(dep.managerData!.source); | ||
| if (!source?.groups) { | ||
| dep.skipReason = 'unsupported-url'; | ||
| return dep; | ||
| } | ||
|
|
||
| // buildin providers https://github.com/terraform-providers | ||
| if (source.groups.namespace === 'terraform-providers') { | ||
| dep.registryUrls = [`https://releases.hashicorp.com`]; | ||
| } else if (source.groups.hostname) { | ||
| dep.registryUrls = [`https://${source.groups.hostname}`]; | ||
| dep.packageName = `${source.groups.namespace}/${source.groups.type}`; | ||
| } else { | ||
| dep.packageName = dep.managerData?.source; | ||
| } | ||
| } | ||
| massageProviderLookupName(dep); | ||
|
|
||
| dep.lockedVersion = getLockedVersion(dep, locks); | ||
|
|
||
| if (!dep.currentValue) { | ||
| dep.skipReason = 'no-version'; | ||
| } | ||
|
|
||
| return dep; | ||
| } | ||
| } |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,158 +1,50 @@ | ||
| import is from '@sindresorhus/is'; | ||
| import { logger } from '../../../logger'; | ||
| import { newlineRegex, regEx } from '../../../util/regex'; | ||
| import type { ExtractConfig, PackageDependency, PackageFile } from '../types'; | ||
| import type { ProviderLock } from './lockfile/types'; | ||
| import { extractLocks, findLockFile, readLockFile } from './lockfile/util'; | ||
| import { analyseTerraformModule, extractTerraformModule } from './modules'; | ||
| import { | ||
| analyzeTerraformProvider, | ||
| extractTerraformProvider, | ||
| } from './providers'; | ||
| import { | ||
| analyzeTerraformRequiredProvider, | ||
| extractTerraformRequiredProviders, | ||
| } from './required-providers'; | ||
| import { | ||
| analyseTerraformVersion, | ||
| extractTerraformRequiredVersion, | ||
| } from './required-version'; | ||
| import { | ||
| analyseTerraformResource, | ||
| extractTerraformResource, | ||
| } from './resources'; | ||
| import type { ExtractionResult, TerraformManagerData } from './types'; | ||
| import type { ExtractConfig, PackageFile } from '../types'; | ||
| import { resourceExtractors } from './extractors'; | ||
| import * as hcl from './hcl'; | ||
| import { | ||
| checkFileContainsDependency, | ||
| getTerraformDependencyType, | ||
| extractLocksForPackageFile, | ||
| } from './util'; | ||
|
|
||
| const dependencyBlockExtractionRegex = regEx( | ||
| /^\s*(?<type>[a-z_]+)\s+("(?<packageName>[^"]+)"\s+)?("(?<terraformName>[^"]+)"\s+)?{\s*$/ | ||
| ); | ||
| const contentCheckList = [ | ||
| 'module "', | ||
| 'provider "', | ||
| '"docker_', | ||
| '"kubernetes_', | ||
| 'required_providers ', | ||
| ' "helm_release" ', | ||
| ' "docker_image" ', | ||
| 'required_version', | ||
| 'terraform_version', // part of tfe_workspace | ||
| ]; | ||
|
|
||
| export async function extractPackageFile( | ||
| content: string, | ||
| fileName: string, | ||
| config: ExtractConfig | ||
| ): Promise<PackageFile | null> { | ||
| logger.trace({ content }, 'terraform.extractPackageFile()'); | ||
| if (!checkFileContainsDependency(content, contentCheckList)) { | ||
|
|
||
| const passedExtractors = []; | ||
| for (const extractor of resourceExtractors) { | ||
| if (checkFileContainsDependency(content, extractor.getCheckList())) { | ||
| passedExtractors.push(extractor); | ||
| } | ||
| } | ||
|
|
||
| if (!passedExtractors.length) { | ||
| logger.trace( | ||
| { fileName }, | ||
| 'preflight content check has not found any relevant content' | ||
| ); | ||
| return null; | ||
| } | ||
| let deps: PackageDependency<TerraformManagerData>[] = []; | ||
| try { | ||
| const lines = content.split(newlineRegex); | ||
| for (let lineNumber = 0; lineNumber < lines.length; lineNumber += 1) { | ||
| const line = lines[lineNumber]; | ||
| const terraformDependency = dependencyBlockExtractionRegex.exec(line); | ||
| if (terraformDependency?.groups) { | ||
| logger.trace( | ||
| `Matched ${terraformDependency.groups.type} on line ${lineNumber}` | ||
| ); | ||
| const tfDepType = getTerraformDependencyType( | ||
| terraformDependency.groups.type | ||
| ); | ||
| let result: ExtractionResult | null = null; | ||
| switch (tfDepType) { | ||
| case 'required_providers': { | ||
| result = extractTerraformRequiredProviders(lineNumber, lines); | ||
| break; | ||
| } | ||
| case 'provider': { | ||
| result = extractTerraformProvider( | ||
| lineNumber, | ||
| lines, | ||
| terraformDependency.groups.packageName | ||
| ); | ||
| break; | ||
| } | ||
| case 'module': { | ||
| result = extractTerraformModule( | ||
| lineNumber, | ||
| lines, | ||
| terraformDependency.groups.packageName | ||
| ); | ||
| break; | ||
| } | ||
| case 'resource': { | ||
| result = extractTerraformResource(lineNumber, lines); | ||
| break; | ||
| } | ||
| case 'terraform_version': { | ||
| result = extractTerraformRequiredVersion(lineNumber, lines); | ||
| break; | ||
| } | ||
| /* istanbul ignore next */ | ||
| default: | ||
| logger.trace( | ||
| `Could not identify TerraformDependencyType ${terraformDependency.groups.type} on line ${lineNumber}.` | ||
| ); | ||
| break; | ||
| } | ||
| if (result) { | ||
| lineNumber = result.lineNumber; | ||
| deps = deps.concat(result.dependencies); | ||
| result = null; | ||
| } | ||
| } | ||
| } | ||
| } catch (err) /* istanbul ignore next */ { | ||
| logger.warn({ err }, 'Error extracting terraform plugins'); | ||
| } | ||
| logger.trace( | ||
| { fileName }, | ||
| `preflight content check passed for extractors: [${passedExtractors | ||
| .map((value) => value.constructor.name) | ||
| .toString()}]` | ||
| ); | ||
|
|
||
| const locks: ProviderLock[] = []; | ||
| const lockFilePath = findLockFile(fileName); | ||
| if (lockFilePath) { | ||
| const lockFileContent = await readLockFile(lockFilePath); | ||
| if (lockFileContent) { | ||
| const extractedLocks = extractLocks(lockFileContent); | ||
| if (is.nonEmptyArray(extractedLocks)) { | ||
| locks.push(...extractedLocks); | ||
| } | ||
| } | ||
| } | ||
| const dependencies = []; | ||
| const hclMap = hcl.parseHCL(content); | ||
|
|
||
| deps.forEach((dep) => { | ||
| switch (dep.managerData?.terraformDependencyType) { | ||
| case 'required_providers': | ||
| analyzeTerraformRequiredProvider(dep, locks); | ||
| break; | ||
| case 'provider': | ||
| analyzeTerraformProvider(dep, locks); | ||
| break; | ||
| case 'module': | ||
| analyseTerraformModule(dep); | ||
| break; | ||
| case 'resource': | ||
| analyseTerraformResource(dep); | ||
| break; | ||
| case 'terraform_version': | ||
| analyseTerraformVersion(dep); | ||
| break; | ||
| /* istanbul ignore next */ | ||
| default: | ||
| } | ||
| const locks = await extractLocksForPackageFile(fileName); | ||
|
|
||
| delete dep.managerData; | ||
| }); | ||
| if (deps.some((dep) => dep.skipReason !== 'local')) { | ||
| return { deps }; | ||
| for (const extractor of passedExtractors) { | ||
| const deps = extractor.extract(hclMap, locks); | ||
| dependencies.push(...deps); | ||
| } | ||
| return null; | ||
|
|
||
| dependencies.forEach((value) => delete value.managerData); | ||
| return { deps: dependencies }; | ||
| } |
Oops, something went wrong.