feat(core)!: Now writing a new contract for the first time requires changedContracts=OVERWRITE

Author: TimothyJones

packages/case-core/src/__tests__/jest/types.ts

@@ -1,11 +1,11 @@
 import { AnyMockDescriptorType } from '@contract-case/case-entities-internal';
-import { CaseContractDescription } from '@contract-case/case-plugin-base/case-core/src/entities/contract/types';
 import {
   ContractDefinerConnector,
   ContractVerifierConnector,
 } from '../../connectors';
 import type { MultiTestInvoker } from '../../core/executeExample/types';
 import type { CaseConfig } from '../../core/types';
+import { CaseContractDescription } from '../../entities/types';
 
 export type CaseJestConfig<T extends AnyMockDescriptorType> =
   CaseContractDescription & {

packages/case-core/src/connectors/contractStore/contractFileWriter/contractFileWriter.ts

@@ -47,14 +47,17 @@ const createDirectory = (
   }
 };
 
+const explicitFilename = (context: HasContractFileConfig) =>
+  context['_case:currentRun:context:contractFilename'];
+
 const actuallyWriteContract = (
   pathToFile: string,
   contract: ContractData,
   context: HasContractFileConfig,
 ) => {
   if (fs.existsSync(pathToFile)) {
     if (
-      context['_case:currentRun:context:contractFilename'] &&
+      explicitFilename(context) &&
       !context['_case:currentRun:context:overwriteFile']
     ) {
       context.logger.error(
@@ -94,6 +97,24 @@ const actuallyWriteContract = (
     }
   }
 
+  if (context['_case:currentRun:context:changedContracts'] === 'FAIL') {
+    throw new CaseConfigurationError(
+      `
+    Tried to write a new contract to
+        ${pathToFile} 
+    But it didn't exist. This isn't allowed with changedContracts set to fail.
+    
+    While ContractCase is running in snapshot test mode, it's a failure to
+    create new contracts. You'll need to re-run your tests with one of:
+    
+    * The configuration property changedContracts is set to 'OVERWRITE'
+    * The environment variable CASE_changedContracts=OVERWRITE
+    `,
+      'DONT_ADD_LOCATION',
+      'OVERWRITE_CONTRACTS_NEEDED',
+    );
+  }
+
   createDirectory(pathToFile, context);
   context.logger.maintainerDebug(`Writing contract to '${pathToFile}'`);
   fs.writeFileSync(pathToFile, JSON.stringify(contract, undefined, 2));

packages/case-core/src/index.internals.duplicate-vars.spec.ts

@@ -1,4 +1,3 @@
-import * as fs from 'node:fs';
 // These imports are our code under test
 import {
   HttpRequestConsumerSetup,
@@ -22,21 +21,13 @@ const contractDetails = {
 const FILENAME = `case-contracts/internal-variable-tests.case.json`;
 
 describe('e2e http consumer driven', () => {
-  beforeAll(() => {
-    // Delete the contract file first
-    try {
-      fs.rmSync(FILENAME);
-      fs.mkdirSync('case-contracts');
-    } catch (e) {
-      // We don't care if this fails
-    }
-  });
   defineContract(
     {
       ...contractDetails,
       config: {
         printResults: false, // Set this to true for you own tests
         contractFilename: FILENAME, // Usually you will not need to provide a filename
+        changedContracts: 'OVERWRITE',
         publish: false,
       },
     },