chore: Prevent provider lock operation from running if disallowed by cli

Author: mutahhir

packages/@cdktf/cli-core/src/lib/cdktf-project.ts

@@ -74,24 +74,31 @@ export type SkipSynthOptions = {
   skipSynth?: boolean;
 };
 
-export type FetchOutputOptions = SkipSynthOptions & MultipleStackOptions;
+export type SkipProviderLockOptions = {
+  skipProviderLock?: boolean;
+};
+
+export type FetchOutputOptions = SkipSynthOptions &
+  SkipProviderLockOptions &
+  MultipleStackOptions;
 
 export type AutoApproveOptions = {
   autoApprove?: boolean;
 };
 
 export type DiffOptions = SingleStackOptions &
+  SkipProviderLockOptions &
   SkipSynthOptions & {
     refreshOnly?: boolean;
     terraformParallelism?: number;
     vars?: string[];
     varFiles?: string[];
     noColor?: boolean;
     migrateState?: boolean;
-    skipSynth?: boolean;
   };
 
 export type MutationOptions = MultipleStackOptions &
+  SkipProviderLockOptions &
   SkipSynthOptions &
   AutoApproveOptions & {
     refreshOnly?: boolean;
@@ -400,7 +407,7 @@ export class CdktfProject {
     const stack = this.getStackExecutor(
       getSingleStack(stacks, opts?.stackName, "diff"),
     );
-    await stack.initalizeTerraform(opts.noColor);
+    await stack.initalizeTerraform(opts.noColor, opts.skipProviderLock);
 
     try {
       await stack.diff(opts);
@@ -449,7 +456,10 @@ export class CdktfProject {
       !opts.parallelism || opts.parallelism < 0 ? Infinity : opts.parallelism;
     const allExecutions = [];
 
-    await this.initializeStacksToRunInSerial(opts.noColor);
+    await this.initializeStacksToRunInSerial(
+      opts.noColor,
+      opts.skipProviderLock,
+    );
     while (this.stacksToRun.filter((stack) => stack.isPending).length > 0) {
       const runningStacks = this.stacksToRun.filter((stack) => stack.isRunning);
       if (runningStacks.length >= maxParallelRuns) {
@@ -657,7 +667,7 @@ export class CdktfProject {
       this.getStackExecutor(stack, {}),
     );
 
-    await this.initializeStacksToRunInSerial();
+    await this.initializeStacksToRunInSerial(undefined, opts.skipProviderLock);
     const outputs = await Promise.all(
       this.stacksToRun.map(async (s) => {
         const output = await s.fetchOutputs();
@@ -676,9 +686,10 @@ export class CdktfProject {
   // Serially run terraform init to prohibit text file busy errors for the cache files
   private async initializeStacksToRunInSerial(
     noColor?: boolean,
+    skipProviderLock?: boolean,
   ): Promise<void> {
     for (const stack of this.stacksToRun) {
-      await stack.initalizeTerraform(noColor);
+      await stack.initalizeTerraform(noColor, skipProviderLock);
     }
   }
 }

packages/@cdktf/cli-core/src/lib/cdktf-stack.ts

@@ -250,9 +250,14 @@ export class CdktfStack {
     );
   }
 
-  public async initalizeTerraform(noColor?: boolean) {
+  public async initalizeTerraform(
+    noColor?: boolean,
+    skipProviderLock?: boolean,
+  ) {
     const terraform = await this.terraformClient();
-    const needsLockfileUpdate = await this.checkNeedsLockfileUpdate();
+    const needsLockfileUpdate = skipProviderLock
+      ? false
+      : await this.checkNeedsLockfileUpdate();
     const needsUpgrade = await this.checkNeedsUpgrade();
     await terraform.init({
       needsUpgrade,

packages/cdktf-cli/src/bin/cmds/ui/deploy.tsx

@@ -67,6 +67,7 @@ interface DeployConfig {
   noColor?: boolean;
   migrateState?: boolean;
   skipSynth?: boolean;
+  skipProviderLock?: boolean;
 }
 
 export const Deploy = ({
@@ -85,6 +86,7 @@ export const Deploy = ({
   noColor,
   migrateState,
   skipSynth,
+  skipProviderLock,
 }: DeployConfig): React.ReactElement => {
   const [outputs, setOutputs] = useState<NestedTerraformOutputs>();
   const { status, logEntries } = useCdktfProject(
@@ -102,6 +104,7 @@ export const Deploy = ({
         noColor,
         migrateState,
         skipSynth,
+        skipProviderLock,
       });
 
       if (onOutputsRetrieved) {

packages/cdktf-cli/src/bin/cmds/ui/destroy.tsx

@@ -27,6 +27,7 @@ interface DestroyConfig {
   vars?: string[];
   varFiles?: string[];
   skipSynth?: boolean;
+  skipProviderLock?: boolean;
 }
 
 export const Destroy = ({
@@ -42,6 +43,7 @@ export const Destroy = ({
   vars,
   varFiles,
   skipSynth,
+  skipProviderLock,
 }: DestroyConfig): React.ReactElement => {
   const { status, logEntries } = useCdktfProject(
     { outDir, synthCommand },
@@ -57,6 +59,7 @@ export const Destroy = ({
         vars,
         varFiles,
         skipSynth,
+        skipProviderLock,
       }),
   );
 

packages/cdktf-cli/src/bin/cmds/ui/diff.tsx

@@ -19,6 +19,7 @@ interface DiffConfig {
   noColor?: boolean;
   migrateState?: boolean;
   skipSynth?: boolean;
+  skipProviderLock?: boolean;
 }
 
 export const Diff = ({
@@ -32,6 +33,7 @@ export const Diff = ({
   noColor,
   migrateState,
   skipSynth,
+  skipProviderLock,
 }: DiffConfig): React.ReactElement => {
   const { status, logEntries } = useCdktfProject(
     { outDir, synthCommand },
@@ -45,6 +47,7 @@ export const Diff = ({
         noColor,
         migrateState,
         skipSynth,
+        skipProviderLock,
       }),
   );