feat(run): add OS variable to use case context (#3)

Author: MarcScheib

README.md

@@ -317,6 +317,7 @@ All steps are working with a context object that is empty initially. Whenever
 a use case starts, the context is filled with the following properties.
 Throughout execution, steps can add or modify properties in the context object.
 
+- `OS`: the operating system where the CLI is executed on; represents the result of [`process.platform`](https://nodejs.org/api/process.html#process_process_platform)
 - `WORKSPACE_PATH`: the absolute path to the workspace
 - `WORKING_DIR`: the absolute path to the working directory, see [Workspace structure](#workspace-structure)
 - `SERVERS`: the list of all servers, see [Server configuration](#server-configuration)

assets/templates/config/use-cases/check-requirements.json

@@ -4,6 +4,11 @@
   "name": "Check requirements",
   "description": "This use case checks the requirements to develop locally.",
   "steps": [
+    {
+      "type": "FORMULA",
+      "description": "Print OS info",
+      "formula": "console.log(`Running on ${OS}`)"
+    },
     {
       "type": "COMMAND",
       "description": "Execute commands",

dist/index.js

@@ -4,6 +4,11 @@
   "name": "Check requirements",
   "description": "This use case checks the requirements to develop locally.",
   "steps": [
+    {
+      "type": "FORMULA",
+      "description": "Print OS info",
+      "formula": "console.log(`Running on ${OS}`)"
+    },
     {
       "type": "COMMAND",
       "description": "Execute commands",

dist/templates/config/use-cases/check-requirements.json

@@ -13,9 +13,9 @@ describe('RepositoriesRepository', () => {
   let sut: RepositoriesRepository;
 
   beforeEach(() => {
-    const config = initConfig(path, 'acme', null);
+    const config = initConfig(path, 'acme', null).store;
 
-    sut = RepositoriesRepository.create(config, TemplatesAccess.create(config));
+    sut = RepositoriesRepository.create(TemplatesAccess.create(config));
   });
 
   it('should load repositories; empty list', async () => {

src/services/repositories.repository.test.ts

@@ -13,7 +13,7 @@ describe('ServersRepository', () => {
   let sut: ServersRepository;
 
   beforeEach(() => {
-    const config = initConfig(path, 'acme', null);
+    const config = initConfig(path, 'acme', null).store;
 
     sut = ServersRepository.create(TemplatesAccess.create(config));
   });

src/services/servers.repository.test.ts

@@ -13,7 +13,7 @@ describe('UseCasesRepository', () => {
   let sut: UseCasesRepository;
 
   beforeEach(() => {
-    const config = initConfig(path, 'acme', null);
+    const config = initConfig(path, 'acme', null).store;
 
     sut = UseCasesRepository.create(TemplatesAccess.create(config));
   });

src/services/use-cases.repository.test.ts

@@ -1,4 +1,5 @@
 import { Context } from '../../types/index.js';
+import { OS } from '../../utils/index.js';
 import { TemplatesAccess } from '../access/index.js';
 import { RepositoriesRepository } from '../repositories.repository.js';
 import { ServersRepository } from '../servers.repository.js';
@@ -25,6 +26,7 @@ export class ContextCreator {
       WORKING_DIR: this.templatesAccess.getWorkingDir(),
       SERVERS: await this.serversRepository.loadServers(),
       REPOSITORIES: await this.repositoriesRepository.loadRepositories(),
+      OS,
     };
   }
 }

src/services/use-cases/context-creator.ts

@@ -16,14 +16,10 @@ describe('UseCaseRunner', () => {
   let sut: UseCaseRunner;
 
   beforeEach(() => {
-    const config = initConfig(path, 'acme', null);
+    const config = initConfig(path, 'acme', null).store;
 
     scriptExecutor = ScriptExecutor.create();
-    sut = UseCaseRunner.create(
-      config,
-      TemplatesAccess.create(config),
-      scriptExecutor
-    );
+    sut = UseCaseRunner.create(TemplatesAccess.create(config), scriptExecutor);
   });
 
   afterEach(() => {

src/services/use-cases/use-case-runner.test.ts

@@ -1,5 +1,7 @@
 import { execSync } from 'node:child_process';
 
+export const OS = process.platform;
+
 export async function execCommand(command: string, cwd: string) {
   return execSync(command, {
     cwd,