@agilecustoms/envctl 0.30.2 → 0.32.0

package/dist/backend/S3Backend.js

@@ -1,8 +1,26 @@
-export class S3Backend {
+import { KnownException } from '../exceptions.js';
+import { TerraformBackend } from './TerraformBackend.js';
+export class S3Backend extends TerraformBackend {
     getType() {
         return 's3';
     }
-    getKey(config) {
-        return config['key'];
+    getKey() {
+        const key = this.config['key'];
+        if (!key) {
+            throw new KnownException(`Terraform backend config does not contain 'key' attribute`);
+        }
+        return key;
+    }
+    validateAndGetStateFileContent() {
+        const allowedKeys = ['bucket', 'dynamodb_table', 'key', 'region', 'use_lockfile'];
+        const nonEmptyKeys = Object.keys(this.config).filter(key => this.config[key] !== null);
+        const invalidKeys = nonEmptyKeys.filter(key => !allowedKeys.includes(key));
+        if (invalidKeys.length > 0) {
+            throw new KnownException(`Terraform local state file ${this.stateFilePath}\n`
+                + `backend config contains not allowed keys: ${invalidKeys.join(', ')}\n`
+                + `Allowed keys are: ${allowedKeys.join(', ')}\n`
+                + `Contact support if you think your backend config is valid`);
+        }
+        return this.stateFileContent;
     }
 }

package/dist/backend/TerraformBackend.js

@@ -1 +1,10 @@
-export {};
+export class TerraformBackend {
+    stateFilePath = '';
+    stateFileContent = '';
+    config = {};
+    setState(stateFilePath, stateFileContent, config) {
+        this.stateFilePath = stateFilePath;
+        this.stateFileContent = stateFileContent;
+        this.config = config;
+    }
+}

package/dist/client/TerraformAdapter.js

@@ -11,6 +11,7 @@ export class TerraformAdapter {
     processRunner;
     cliHelper;
     backends;
+    backend = undefined;
     constructor(processRunner, cliHelper, backends) {
         this.processRunner = processRunner;
         this.cliHelper = cliHelper;
@@ -19,21 +20,6 @@ export class TerraformAdapter {
             return acc;
         }, new Map());
     }
-    getStateFile(cwd) {
-        const dir = cwd ?? process.cwd();
-        const statePath = path.join(dir, '.terraform', 'terraform.tfstate');
-        if (!fs.existsSync(statePath)) {
-            throw new KnownException(`Terraform state file not found at: ${statePath}`);
-        }
-        let content;
-        try {
-            content = fs.readFileSync(statePath, 'utf8');
-        }
-        catch (err) {
-            throw new KnownException(`Failed to read terraform state file: ${statePath}`, { cause: err });
-        }
-        return content;
-    }
     getLockFile(cwd) {
         const dir = cwd ?? process.cwd();
         const lockPath = path.join(dir, '.terraform.lock.hcl');
@@ -47,11 +33,25 @@ export class TerraformAdapter {
             throw new KnownException(`Failed to read terraform lock file: ${lockPath}`, { cause: err });
         }
     }
-    getKey(cwd) {
-        const stateFile = this.getStateFile(cwd);
+    getTerraformBackend(cwd) {
+        if (this.backend) {
+            return this.backend;
+        }
+        const dir = cwd ?? process.cwd();
+        const statePath = path.join(dir, '.terraform', 'terraform.tfstate');
+        if (!fs.existsSync(statePath)) {
+            throw new KnownException(`Terraform state file not found at: ${statePath}`);
+        }
+        let stateFileContent;
+        try {
+            stateFileContent = fs.readFileSync(statePath, 'utf8');
+        }
+        catch (err) {
+            throw new KnownException(`Failed to read terraform state file: ${statePath}`, { cause: err });
+        }
         let tfstate;
         try {
-            tfstate = JSON.parse(stateFile);
+            tfstate = JSON.parse(stateFileContent);
         }
         catch (err) {
             throw new KnownException(`Failed to parse terraform state file: .terraform/terraform.tfstate`, { cause: err });
@@ -63,12 +63,9 @@ export class TerraformAdapter {
             const supportedBackends = Array.from(this.backends.keys()).join(',');
             throw new KnownException(`Unsupported terraform backend type: ${type}. Supported types: ${supportedBackends}`);
         }
-        const config = backendJson?.config;
-        const key = backend.getKey(config);
-        if (!key) {
-            throw new KnownException(`Terraform backend config does not contain 'key' attribute`);
-        }
-        return key;
+        backend.setState(statePath, stateFileContent, backendJson.config);
+        this.backend = backend;
+        return backend;
     }
     async lockProviders(cwd) {
         console.log('Update lock file');

package/dist/service/EnvCtl.js

@@ -14,7 +14,7 @@ export class EnvCtl {
     getKey(key, cwd) {
         if (!key) {
             console.log('Key is not provided, inferring from .terraform/terraform.tfstate file');
-            key = this.terraformAdapter.getKey(cwd);
+            key = this.terraformAdapter.getTerraformBackend(cwd).getKey();
         }
         return key;
     }
@@ -80,7 +80,7 @@ export class EnvCtl {
         throw new KnownException(`Env ${env.key} status is ${env.status}, can not run this command`);
     }
     async plan(tfArgs, cwd) {
-        const key = this.terraformAdapter.getKey(cwd);
+        const key = this.terraformAdapter.getTerraformBackend(cwd).getKey();
         const userName = this.configService.getUserName();
         const env = await this.tryGetEnv(key);
         let vars = undefined;
@@ -105,19 +105,20 @@ export class EnvCtl {
         return await this.envApi.createEphemeral(createEnv);
     }
     async lockTerraform(env, cwd) {
+        console.log('validate terraform.tfstate file');
+        env.stateFile = this.terraformAdapter.getTerraformBackend(cwd).validateAndGetStateFileContent();
         await this.terraformAdapter.lockProviders(cwd);
-        env.stateFile = this.terraformAdapter.getStateFile(cwd);
         env.lockFile = this.terraformAdapter.getLockFile(cwd);
     }
     async deploy(tfArgs, cwd) {
-        const key = this.terraformAdapter.getKey(cwd);
+        const key = this.terraformAdapter.getTerraformBackend(cwd).getKey();
         let env = await this.tryGetEnv(key);
         if (env === null) {
             const kind = this.cliHelper.getKind(cwd);
-            console.log('Creating env metadata');
             const userName = this.configService.getUserName();
             const createEnv = { key, owner: userName, kind };
             await this.lockTerraform(createEnv, cwd);
+            console.log('Creating env metadata');
             env = await this.envApi.create(createEnv);
         }
         else {
@@ -191,7 +192,7 @@ export class EnvCtl {
         console.log(message);
     }
     async destroy(tfArgs, force, cwd) {
-        const key = this.terraformAdapter.getKey(cwd);
+        const key = this.terraformAdapter.getTerraformBackend(cwd).getKey();
         const env = await this.get(key);
         this.checkStatus(env);
         if (env.status === EnvStatus.Init) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@agilecustoms/envctl",
   "description": "node.js CLI client for manage environments",
-  "version": "0.30.2",
+  "version": "0.32.0",
   "author": "Alex Chekulaev",
   "type": "module",
   "bin": {