@causa/workspace-terraform 0.2.0 → 0.3.0

package/README.md

@@ -33,3 +33,4 @@ The Terraform module also supports some of the project-level commands, namely:
 
 - `cs init`: Runs `terraform init`.
 - `cs lint`: Runs `terraform validate` and `terraform fmt`. The format operation is run with the `-check` argument, such that it only lints the code without fixing it. This operation applies supports the `project.additionalDirectories` configuration.
+- `cs dependencies update`: Runs `terraform init` with the `-upgrade` option, allowing the update of dependencies and the lock file.

package/dist/functions/index.js

@@ -1,7 +1,8 @@
 import { InfrastructureDeployForTerraform } from './infrastructure-deploy-terraform.js';
 import { InfrastructurePrepareForTerraform } from './infrastructure-prepare-terraform.js';
+import { ProjectDependenciesUpdateForTerraform } from './project-dependencies-update-terraform.js';
 import { ProjectInitForTerraform } from './project-init-terraform.js';
 import { ProjectLintForTerraform } from './project-lint-terraform.js';
 export function registerFunctions(context) {
-    context.registerFunctionImplementations(InfrastructureDeployForTerraform, InfrastructurePrepareForTerraform, ProjectInitForTerraform, ProjectLintForTerraform);
+    context.registerFunctionImplementations(InfrastructureDeployForTerraform, InfrastructurePrepareForTerraform, ProjectDependenciesUpdateForTerraform, ProjectInitForTerraform, ProjectLintForTerraform);
 }

package/dist/functions/infrastructure-prepare-terraform.js

@@ -18,7 +18,7 @@ export class InfrastructurePrepareForTerraform extends InfrastructurePrepare {
         const variables = (await infrastructureConf.getAndRender('infrastructure.variables')) ?? {};
         const output = resolve(this.output ?? DEFAULT_PLAN_FILE);
         context.logger.info(`🧱 Planning Terraform deployment for project '${projectName}'.`);
-        const isDeploymentNeeded = await terraformService.wrapWorkspaceOperation({ createWorkspaceIfNeeded: true }, () => terraformService.plan(output, { variables }));
+        const isDeploymentNeeded = await terraformService.wrapWorkspaceOperation({ createWorkspaceIfNeeded: !this.destroy }, () => terraformService.plan(output, { variables, destroy: this.destroy }));
         if (isDeploymentNeeded) {
             context.logger.info('🧱 Terraform plan has changes that can be deployed.');
             if (this.print) {

package/dist/functions/project-dependencies-update-terraform.d.ts

@@ -0,0 +1,11 @@
+import { WorkspaceContext } from '@causa/workspace';
+import { ProjectDependenciesUpdate } from '@causa/workspace-core';
+/**
+ * Implements the {@link ProjectDependenciesUpdate} function for Terraform projects, by running `terraform init`.
+ * This uses the `-upgrade` option to fetch the latest versions of the providers allowed by configured constraints, and
+ * updates the lock file accordingly.
+ */
+export declare class ProjectDependenciesUpdateForTerraform extends ProjectDependenciesUpdate {
+    _call(context: WorkspaceContext): Promise<void>;
+    _supports(context: WorkspaceContext): boolean;
+}

package/dist/functions/project-dependencies-update-terraform.js

@@ -0,0 +1,20 @@
+import { ProjectDependenciesUpdate } from '@causa/workspace-core';
+import { TerraformService } from '../services/index.js';
+/**
+ * Implements the {@link ProjectDependenciesUpdate} function for Terraform projects, by running `terraform init`.
+ * This uses the `-upgrade` option to fetch the latest versions of the providers allowed by configured constraints, and
+ * updates the lock file accordingly.
+ */
+export class ProjectDependenciesUpdateForTerraform extends ProjectDependenciesUpdate {
+    async _call(context) {
+        context.logger.info('⬆️ Updating Terraform dependencies.');
+        await context
+            .service(TerraformService)
+            .init({ upgrade: true, logging: 'debug' });
+        context.logger.info(`️✅ Successfully updated Terraform dependencies.`);
+    }
+    _supports(context) {
+        return (context.get('project.language') === 'terraform' &&
+            context.get('project.type') === 'infrastructure');
+    }
+}

package/dist/functions/project-lint-terraform.js

@@ -26,6 +26,7 @@ export class ProjectLintForTerraform extends ProjectLint {
                 targets,
                 logging: 'info',
             });
+            context.logger.info('✅ Terraform code passed linting.');
         }
         catch (error) {
             if (error instanceof ProcessServiceExitCodeError) {

package/dist/services/terraform.d.ts

@@ -50,7 +50,12 @@ export declare class TerraformService {
      *
      * @param options Options when initializing Terraform.
      */
-    init(options?: SpawnOptions): Promise<void>;
+    init(options?: {
+        /**
+         * Upgrades the module and provider versions during initialization, instead of using the lockfile.
+         */
+        upgrade?: boolean;
+    } & SpawnOptions): Promise<void>;
     /**
      * Runs `terraform workspace show` and returns the currently selected workspace.
      *
@@ -65,6 +70,9 @@ export declare class TerraformService {
      * @param options Options when running the command.
      */
     workspaceSelect(workspace: string, options?: {
+        /**
+         * Creates the workspace if it does not already exists.
+         */
         orCreate?: boolean;
     } & SpawnOptions): Promise<void>;
     /**

package/dist/services/terraform.js

@@ -44,7 +44,11 @@ export class TerraformService {
      * @param options Options when initializing Terraform.
      */
     async init(options = {}) {
-        await this.terraform('init', ['-input=false'], options);
+        const args = ['-input=false'];
+        if (options.upgrade) {
+            args.push('-upgrade');
+        }
+        await this.terraform('init', args, options);
     }
     /**
      * Runs `terraform workspace show` and returns the currently selected workspace.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@causa/workspace-terraform",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "The Causa workspace module providing functionalities for infrastructure projects coded in Terraform.",
   "repository": "github:causa-io/workspace-module-terraform",
   "license": "ISC",
@@ -28,24 +28,24 @@
     "test:cov": "npm run test -- --coverage"
   },
   "dependencies": {
-    "@causa/workspace": ">= 0.10.0 < 1.0.0",
-    "@causa/workspace-core": ">= 0.7.0 < 1.0.0",
-    "pino": "^8.14.1",
-    "semver": "^7.5.1"
+    "@causa/workspace": ">= 0.12.0 < 1.0.0",
+    "@causa/workspace-core": ">= 0.11.0 < 1.0.0",
+    "pino": "^8.14.2",
+    "semver": "^7.5.4"
   },
   "devDependencies": {
-    "@tsconfig/node18": "^2.0.1",
-    "@types/jest": "^29.5.2",
-    "@types/node": "^18.16.14",
-    "@typescript-eslint/eslint-plugin": "^5.59.9",
-    "eslint": "^8.42.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "jest": "^29.5.0",
+    "@tsconfig/node18": "^18.2.0",
+    "@types/jest": "^29.5.3",
+    "@types/node": "^18.17.1",
+    "@typescript-eslint/eslint-plugin": "^6.2.0",
+    "eslint": "^8.46.0",
+    "eslint-config-prettier": "^8.9.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "jest": "^29.6.2",
     "jest-extended": "^4.0.0",
     "rimraf": "^5.0.1",
-    "ts-jest": "^29.1.0",
+    "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.3"
+    "typescript": "^5.1.6"
   }
 }