Fix invisible script execution on Windows #264

This commit addresses an issue in the privacy.sexy desktop application
where scripts executed as administrator on Windows were running in the
background. This was observed in environments like Windows Pro VMs on
Azure, where operations typically run with administrative privileges.

Previously, the application used the `"$path"` shell command to execute
scripts. This mechanism failed to activate the logic for requesting
admin privileges if the app itself was running as an administrator.
To resolve this, the script execution process has been modified to
explicitly ask for administrator privileges using the `VerbAs` method.
This ensures that the script always runs in a new `cmd.exe` window,
enhancing visibility and user interaction.

Other supporting changes:

- Rename the generated script file from `run-{timestamp}-{extension}` er
  to `{timestamp}-privacy-script-{extension}` for clearer identification
  and better file sorting.
- Refactor `ScriptFileCreator` to parameterize file extension and
  script name.
- Rename `OsTimestampedFilenameGenerator` to
  `TimestampedFilenameGenerator` to better reflect its new and more
  scoped functionality after refactoring mentioned abvoe.
- Remove `setAppName()` due to ineffective behavior in Windows.
- Update `SECURITY.md` to highlight that the app doesn't require admin
  rights for standard operations.
- Add `.editorconfig` settings for PowerShell scripts.
- Add a integration test for script execution logic. Improve environment
  detection for more reliable test execution.
- Disable application logging during unit/integration tests to keep test
  outputs clean and focused.
This commit is contained in:
undergroundwires
2024-01-09 20:44:06 +01:00
parent 728584240c
commit b404a91ada
32 changed files with 716 additions and 290 deletions

View File

@@ -1,10 +1,11 @@
# Top-most EditorConfig file root = true # Top-most EditorConfig file
root = true
[*]
end_of_line = lf
[*.{js,jsx,ts,tsx,vue,sh}] [*.{js,jsx,ts,tsx,vue,sh}]
indent_style = space indent_style = space
indent_size = 2 indent_size = 2
end_of_line = lf
trim_trailing_whitespace = true trim_trailing_whitespace = true
insert_final_newline = true insert_final_newline = true
max_line_length = 100 max_line_length = 100
@@ -17,3 +18,9 @@ indent_size = 4
indent_size = 4 # PEP 8 (the official Python style guide) recommends using 4 spaces per indentation level indent_size = 4 # PEP 8 (the official Python style guide) recommends using 4 spaces per indentation level
indent_style = space indent_style = space
max_line_length = 100 max_line_length = 100
[*.ps1]
indent_style = space
indent_size = 4
trim_trailing_whitespace = true
insert_final_newline = true

View File

@@ -37,6 +37,10 @@ privacy.sexy adopts a defense in depth strategy to protect users on multiple lay
- **Auditing and Transparency:** - **Auditing and Transparency:**
The desktop application improves security and transparency by logging application activities and retaining files of executed scripts The desktop application improves security and transparency by logging application activities and retaining files of executed scripts
This facilitates detailed auditability and effective troubleshooting, contributing to the integrity and reliability of the application. This facilitates detailed auditability and effective troubleshooting, contributing to the integrity and reliability of the application.
- **Privilege Management:**
The desktop application operates without persistent administrative or `sudo` privileges, reinforcing its security posture. It requests
elevation of privileges for system modifications with explicit user consent and logs every action taken with high privileges. This
approach actively minimizes potential security risks by limiting privileged operations and aligning with the principle of least privilege.
### Update Security and Integrity ### Update Security and Integrity

View File

@@ -1,5 +1,6 @@
export interface CodeRunner { export interface CodeRunner {
runCode( runCode(
code: string, code: string,
fileExtension: string,
): Promise<void>; ): Promise<void>;
} }

View File

@@ -0,0 +1 @@
export const ScriptFileName = 'privacy-script' as const;

View File

@@ -1,3 +1,5 @@
import { ScriptFileNameParts } from '../ScriptFileCreator';
export interface FilenameGenerator { export interface FilenameGenerator {
generateFilename(): string; generateFilename(scriptFileNameParts: ScriptFileNameParts): string;
} }

View File

@@ -1,47 +0,0 @@
import { OperatingSystem } from '@/domain/OperatingSystem';
import { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
import { CurrentEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
import { FilenameGenerator } from './FilenameGenerator';
/**
* Generates a timestamped filename specific to the given operating system.
*
* The filename includes:
* - A timestamp for uniqueness and easier auditability.
* - File extension based on the operating system.
*/
export class OsTimestampedFilenameGenerator implements FilenameGenerator {
private readonly currentOs?: OperatingSystem;
constructor(
environment: RuntimeEnvironment = CurrentEnvironment,
) {
this.currentOs = environment.os;
}
public generateFilename(
date = new Date(),
): string {
const baseFileName = `run-${createTimeStampForFile(date)}`;
const extension = this.currentOs === undefined ? undefined : FileExtensions[this.currentOs];
return extension ? `${baseFileName}.${extension}` : baseFileName;
}
}
const FileExtensions: Partial<Record<OperatingSystem, string>> = {
// '.bat' for Windows batch files; required for executability.
[OperatingSystem.Windows]: 'bat',
// '.sh' for Unix-like systems; enhances recognition as a shell script
[OperatingSystem.macOS]: 'sh',
[OperatingSystem.Linux]: 'sh',
};
/** Generates a timestamp for the filename in 'YYYY-MM-DD_HH-MM-SS' format. */
function createTimeStampForFile(date: Date): string {
return date
.toISOString()
.replace(/T/, '_')
.replace(/:/g, '-')
.replace(/\..+/, '');
}

View File

@@ -0,0 +1,31 @@
import { ScriptFileNameParts } from '../ScriptFileCreator';
import { FilenameGenerator } from './FilenameGenerator';
export class TimestampedFilenameGenerator implements FilenameGenerator {
public generateFilename(
scriptFileNameParts: ScriptFileNameParts,
date = new Date(),
): string {
validateScriptFileNameParts(scriptFileNameParts);
const baseFileName = `${createTimeStampForFile(date)}-${scriptFileNameParts.scriptName}`;
return scriptFileNameParts.scriptFileExtension ? `${baseFileName}.${scriptFileNameParts.scriptFileExtension}` : baseFileName;
}
}
/** Generates a timestamp for the filename in 'YYYY-MM-DD_HH-MM-SS' format. */
function createTimeStampForFile(date: Date): string {
return date
.toISOString()
.replace(/T/, '_')
.replace(/:/g, '-')
.replace(/\..+/, '');
}
function validateScriptFileNameParts(scriptFileNameParts: ScriptFileNameParts) {
if (!scriptFileNameParts.scriptName) {
throw new Error('Script name is required but not provided.');
}
if (scriptFileNameParts.scriptFileExtension?.startsWith('.')) {
throw new Error('File extension should not start with a dot.');
}
}

View File

@@ -3,27 +3,30 @@ import { Logger } from '@/application/Common/Log/Logger';
import { SystemOperations } from '../System/SystemOperations'; import { SystemOperations } from '../System/SystemOperations';
import { NodeElectronSystemOperations } from '../System/NodeElectronSystemOperations'; import { NodeElectronSystemOperations } from '../System/NodeElectronSystemOperations';
import { FilenameGenerator } from './Filename/FilenameGenerator'; import { FilenameGenerator } from './Filename/FilenameGenerator';
import { ScriptFileCreator } from './ScriptFileCreator'; import { ScriptFileNameParts, ScriptFileCreator } from './ScriptFileCreator';
import { OsTimestampedFilenameGenerator } from './Filename/OsTimestampedFilenameGenerator'; import { TimestampedFilenameGenerator } from './Filename/TimestampedFilenameGenerator';
import { ScriptDirectoryProvider } from './Directory/ScriptDirectoryProvider'; import { ScriptDirectoryProvider } from './Directory/ScriptDirectoryProvider';
import { PersistentDirectoryProvider } from './Directory/PersistentDirectoryProvider'; import { PersistentDirectoryProvider } from './Directory/PersistentDirectoryProvider';
export class ScriptFileCreationOrchestrator implements ScriptFileCreator { export class ScriptFileCreationOrchestrator implements ScriptFileCreator {
constructor( constructor(
private readonly system: SystemOperations = new NodeElectronSystemOperations(), private readonly system: SystemOperations = new NodeElectronSystemOperations(),
private readonly filenameGenerator: FilenameGenerator = new OsTimestampedFilenameGenerator(), private readonly filenameGenerator: FilenameGenerator = new TimestampedFilenameGenerator(),
private readonly directoryProvider: ScriptDirectoryProvider = new PersistentDirectoryProvider(), private readonly directoryProvider: ScriptDirectoryProvider = new PersistentDirectoryProvider(),
private readonly logger: Logger = ElectronLogger, private readonly logger: Logger = ElectronLogger,
) { } ) { }
public async createScriptFile(contents: string): Promise<string> { public async createScriptFile(
const filePath = await this.provideFilePath(); contents: string,
scriptFileNameParts: ScriptFileNameParts,
): Promise<string> {
const filePath = await this.provideFilePath(scriptFileNameParts);
await this.createFile(filePath, contents); await this.createFile(filePath, contents);
return filePath; return filePath;
} }
private async provideFilePath(): Promise<string> { private async provideFilePath(scriptFileNameParts: ScriptFileNameParts): Promise<string> {
const filename = this.filenameGenerator.generateFilename(); const filename = this.filenameGenerator.generateFilename(scriptFileNameParts);
const directoryPath = await this.directoryProvider.provideScriptDirectory(); const directoryPath = await this.directoryProvider.provideScriptDirectory();
const filePath = this.system.location.combinePaths(directoryPath, filename); const filePath = this.system.location.combinePaths(directoryPath, filename);
return filePath; return filePath;

View File

@@ -1,3 +1,11 @@
export interface ScriptFileCreator { export interface ScriptFileCreator {
createScriptFile(contents: string): Promise<string>; createScriptFile(
contents: string,
scriptFileNameParts: ScriptFileNameParts,
): Promise<string>;
}
export interface ScriptFileNameParts {
readonly scriptName: string;
readonly scriptFileExtension: string | undefined;
} }

View File

@@ -24,6 +24,10 @@ export class VisibleTerminalScriptExecutor implements ScriptFileExecutor {
} }
private async setFileExecutablePermissions(filePath: string): Promise<void> { private async setFileExecutablePermissions(filePath: string): Promise<void> {
/*
This is required on macOS and Linux otherwise the terminal emulators will refuse to
execute the script. It's not needed on Windows.
*/
this.logger.info(`Setting execution permissions for file at ${filePath}`); this.logger.info(`Setting execution permissions for file at ${filePath}`);
await this.system.fileSystem.setFilePermissions(filePath, '755'); await this.system.fileSystem.setFilePermissions(filePath, '755');
this.logger.info(`Execution permissions set successfully for ${filePath}`); this.logger.info(`Execution permissions set successfully for ${filePath}`);
@@ -53,43 +57,93 @@ interface TerminalExecutionContext {
type TerminalRunner = (context: TerminalExecutionContext) => Promise<void>; type TerminalRunner = (context: TerminalExecutionContext) => Promise<void>;
export const LinuxTerminalEmulator = 'x-terminal-emulator';
const TerminalRunners: Partial<Record<OperatingSystem, TerminalRunner>> = { const TerminalRunners: Partial<Record<OperatingSystem, TerminalRunner>> = {
[OperatingSystem.Windows]: async (context) => { [OperatingSystem.Windows]: async (context) => {
const command = [
'PowerShell',
'Start-Process',
'-Verb RunAs', // Run as administrator with GUI sudo prompt
`-FilePath ${cmdShellPathArgumentEscape(context.scriptFilePath)}`,
].join(' ');
/* /*
Options: 📝 Options:
"path": `child_process.execFile()`
✅ Launches the script within `cmd.exe`. "path", `cmd.exe /c "path"`
✅ Uses user-friendly GUI sudo prompt. ❌ Script execution in the background without a visible terminal.
This occurs only when the user runs the application as administrator, as seen
in Windows Pro VMs on Azure.
`PowerShell Start -Verb RunAs "path"`
✅ Visible terminal window
✅ GUI sudo prompt (through `RunAs` option)
`PowerShell Start "path"`
`explorer.exe "path"`
`electron.shell.openPath`
`start cmd.exe /c "$path"`
✅ Visible terminal window
✅ GUI sudo prompt (through `RunAs` option)
👍 Among all options `start` command is the most explicit one, being the most resilient
against the potential changes in Windows or Electron framework (e.g. https://github.com/electron/electron/issues/36765).
`%COMSPEC%` environment variable should be checked before defaulting to `cmd.exe.
Related docs: https://web.archive.org/web/20240106002357/https://nodejs.org/api/child_process.html#spawning-bat-and-cmd-files-on-windows
*/ */
const command = cmdShellPathArgumentEscape(context.scriptFilePath);
await runCommand(command, context); await runCommand(command, context);
}, },
[OperatingSystem.Linux]: async (context) => { [OperatingSystem.Linux]: async (context) => {
const command = `x-terminal-emulator -e ${posixShellPathArgumentEscape(context.scriptFilePath)}`; const command = `${LinuxTerminalEmulator} -e ${posixShellPathArgumentEscape(context.scriptFilePath)}`;
/* /*
Options: 🤔 Potential improvements:
`x-terminal-emulator -e`: Use user-friendly GUI sudo prompt (not terminal-based).
✅ Launches the script within the default terminal emulator. If `pkexec` exists, we could do `x-terminal-emulator -e pkexec 'path'`, which always
❌ Requires terminal-based (not GUI) sudo prompt, which may not be very user friendly. prompts with user-friendly GUI sudo prompt.
📝 Options:
`x-terminal-emulator -e 'path'`:
✅ Visible terminal window
❌ Terminal-based (not GUI) sudo prompt.
`x-terminal-emulator -e pkexec 'path'
✅ Visible terminal window
✅ Always prompts with user-friendly GUI sudo prompt.
🤔 Not using `pkexec` as it is not in all Linux distributions. It should have smarter
logic to handle if it does not exist.
`electron.shell.openPath`:
❌ Opens the script in the default text editor, verified on
Debian/Ubuntu-based distributions.
`child_process.execFile()`:
❌ Script execution in the background without a visible terminal.
*/ */
await runCommand(command, context); await runCommand(command, context);
}, },
[OperatingSystem.macOS]: async (context) => { [OperatingSystem.macOS]: async (context) => {
const command = `open -a Terminal.app ${posixShellPathArgumentEscape(context.scriptFilePath)}`; const command = `open -a Terminal.app ${posixShellPathArgumentEscape(context.scriptFilePath)}`;
// -a Specifies the application to use for opening the file
/* eslint-disable vue/max-len */
/* /*
Options: 🤔 Potential improvements:
`open -a Terminal.app`: Use user-friendly GUI sudo prompt for running the script.
✅ Launches the script within Terminal app, that exists natively in all modern macOS 📝 Options:
versions. `open -a Terminal.app 'path'`
❌ Requires terminal-based (not GUI) sudo prompt, which may not be very user friendly. ✅ Visible terminal window
❌ Terminal app requires many privileges to execute the script, this would prompt user Terminal-based (not GUI) sudo prompt.
❌ Terminal app requires many privileges to execute the script, this prompts user
to grant privileges to the Terminal app. to grant privileges to the Terminal app.
`osascript -e 'do shell script "'/tmp/test.sh'" with administrator privileges'`
`osascript -e "do shell script \\"${scriptPath}\\" with administrator privileges"`: ✅ Script as root
Uses user-friendly GUI sudo prompt. ✅ GUI sudo prompt.
Executes the script in the background, which does not provide the user with immediate Script execution in the background without a visible terminal.
visual feedback or allow interaction with the script as it runs. `osascript -e 'do shell script "open -a 'Terminal.app' '/tmp/test.sh'" with administrator privileges'`
❌ Script as user, not root
✅ GUI sudo prompt.
✅ Visible terminal window
`osascript -e 'do shell script "/System/Applications/Utilities/Terminal.app/Contents/MacOS/Terminal '/tmp/test.sh'" with administrator privileges'`
✅ Script as root
✅ GUI sudo prompt.
✅ Visible terminal window
Useful resources about `do shell script .. with administrator privileges`:
- Change "osascript wants to make changes" prompt: https://web.archive.org/web/20240109191128/https://apple.stackexchange.com/questions/283353/how-to-rename-osascript-in-the-administrator-privileges-dialog
- More about `do shell script`: https://web.archive.org/web/20100906222226/http://developer.apple.com/mac/library/technotes/tn2002/tn2065.html
*/ */
/* eslint-enable vue/max-len */
await runCommand(command, context); await runCommand(command, context);
}, },
} as const; } as const;
@@ -101,11 +155,13 @@ async function runCommand(command: string, context: TerminalExecutionContext): P
} }
function posixShellPathArgumentEscape(pathArgument: string): string { function posixShellPathArgumentEscape(pathArgument: string): string {
// - Wraps the path in single quotes, which is a standard practice in POSIX shells /*
// (like bash and zsh) found on macOS/Linux to ensure that characters like spaces, '*', and - Wraps the path in single quotes, which is a standard practice in POSIX shells
// '?' are treated as literals, not as special characters. (like bash and zsh) found on macOS/Linux to ensure that characters like spaces, '*', and
// - Escapes any single quotes within the path itself. This allows paths containing single '?' are treated as literals, not as special characters.
// quotes to be correctly interpreted in POSIX-compliant systems, such as Linux and macOS. - Escapes any single quotes within the path itself. This allows paths containing single
quotes to be correctly interpreted in POSIX-compliant systems, such as Linux and macOS.
*/
return `'${pathArgument.replaceAll('\'', '\'\\\'\'')}'`; return `'${pathArgument.replaceAll('\'', '\'\\\'\'')}'`;
} }

View File

@@ -1,24 +1,30 @@
import { CodeRunner } from '@/application/CodeRunner';
import { Logger } from '@/application/Common/Log/Logger'; import { Logger } from '@/application/Common/Log/Logger';
import { ScriptFileName } from '@/application/CodeRunner/ScriptFileName';
import { CodeRunner } from '@/application/CodeRunner/CodeRunner';
import { ElectronLogger } from '../Log/ElectronLogger'; import { ElectronLogger } from '../Log/ElectronLogger';
import { ScriptFileExecutor } from './Execution/ScriptFileExecutor'; import { ScriptFileExecutor } from './Execution/ScriptFileExecutor';
import { VisibleTerminalScriptExecutor } from './Execution/VisibleTerminalScriptFileExecutor';
import { ScriptFileCreator } from './Creation/ScriptFileCreator'; import { ScriptFileCreator } from './Creation/ScriptFileCreator';
import { ScriptFileCreationOrchestrator } from './Creation/ScriptFileCreationOrchestrator'; import { ScriptFileCreationOrchestrator } from './Creation/ScriptFileCreationOrchestrator';
import { VisibleTerminalScriptExecutor } from './Execution/VisibleTerminalScriptFileExecutor';
export class ScriptFileCodeRunner implements CodeRunner { export class ScriptFileCodeRunner implements CodeRunner {
constructor( constructor(
private readonly scriptFileExecutor: ScriptFileExecutor = new VisibleTerminalScriptExecutor(), private readonly scriptFileExecutor
: ScriptFileExecutor = new VisibleTerminalScriptExecutor(),
private readonly scriptFileCreator: ScriptFileCreator = new ScriptFileCreationOrchestrator(), private readonly scriptFileCreator: ScriptFileCreator = new ScriptFileCreationOrchestrator(),
private readonly logger: Logger = ElectronLogger, private readonly logger: Logger = ElectronLogger,
) { } ) { }
public async runCode( public async runCode(
code: string, code: string,
fileExtension: string,
): Promise<void> { ): Promise<void> {
this.logger.info('Initiating script running process.'); this.logger.info('Initiating script running process.');
try { try {
const scriptFilePath = await this.scriptFileCreator.createScriptFile(code); const scriptFilePath = await this.scriptFileCreator.createScriptFile(code, {
scriptName: ScriptFileName,
scriptFileExtension: fileExtension,
});
await this.scriptFileExecutor.executeScriptFile(scriptFilePath); await this.scriptFileExecutor.executeScriptFile(scriptFilePath);
this.logger.info(`Successfully ran script at ${scriptFilePath}`); this.logger.info(`Successfully ran script at ${scriptFilePath}`);
} catch (error) { } catch (error) {

View File

@@ -2,26 +2,33 @@ import { BrowserRuntimeEnvironment } from './Browser/BrowserRuntimeEnvironment';
import { NodeRuntimeEnvironment } from './Node/NodeRuntimeEnvironment'; import { NodeRuntimeEnvironment } from './Node/NodeRuntimeEnvironment';
import { RuntimeEnvironment } from './RuntimeEnvironment'; import { RuntimeEnvironment } from './RuntimeEnvironment';
export const CurrentEnvironment = determineAndCreateRuntimeEnvironment( export const CurrentEnvironment = determineAndCreateRuntimeEnvironment({
() => globalThis.window, getGlobalWindow: () => globalThis.window,
); getGlobalProcess: () => globalThis.process,
});
export function determineAndCreateRuntimeEnvironment( export function determineAndCreateRuntimeEnvironment(
windowAccessor: WindowAccessor, globalAccessor: GlobalAccessor,
browserEnvironmentFactory: BrowserRuntimeEnvironmentFactory = ( browserEnvironmentFactory: BrowserRuntimeEnvironmentFactory = (
window, window,
) => new BrowserRuntimeEnvironment(window), ) => new BrowserRuntimeEnvironment(window),
nodeEnvironmentFactory: NodeRuntimeEnvironmentFactory = () => new NodeRuntimeEnvironment(), nodeEnvironmentFactory: NodeRuntimeEnvironmentFactory = () => new NodeRuntimeEnvironment(),
): RuntimeEnvironment { ): RuntimeEnvironment {
const window = windowAccessor(); if (globalAccessor.getGlobalProcess()) {
return nodeEnvironmentFactory();
}
const window = globalAccessor.getGlobalWindow();
if (window) { if (window) {
return browserEnvironmentFactory(window); return browserEnvironmentFactory(window);
} }
return nodeEnvironmentFactory(); throw new Error('Unsupported runtime environment: The current context is neither a recognized browser nor a Node.js environment.');
} }
export type BrowserRuntimeEnvironmentFactory = (window: Window) => RuntimeEnvironment; export type BrowserRuntimeEnvironmentFactory = (window: Window) => RuntimeEnvironment;
export type NodeRuntimeEnvironmentFactory = () => NodeRuntimeEnvironment; export type NodeRuntimeEnvironmentFactory = () => NodeRuntimeEnvironment;
export type WindowAccessor = () => Window | undefined; export interface GlobalAccessor {
getGlobalWindow(): Window | undefined;
getGlobalProcess(): NodeJS.Process | undefined;
}

View File

@@ -1,6 +1,6 @@
import { OperatingSystem } from '@/domain/OperatingSystem'; import { OperatingSystem } from '@/domain/OperatingSystem';
import { Logger } from '@/application/Common/Log/Logger'; import { Logger } from '@/application/Common/Log/Logger';
import { CodeRunner } from '@/application/CodeRunner'; import { CodeRunner } from '@/application/CodeRunner/CodeRunner';
/* Primary entry point for platform-specific injections */ /* Primary entry point for platform-specific injections */
export interface WindowVariables { export interface WindowVariables {

View File

@@ -13,15 +13,41 @@ export class ClientLoggerFactory implements LoggerFactory {
protected constructor( protected constructor(
environment: RuntimeEnvironment = CurrentEnvironment, environment: RuntimeEnvironment = CurrentEnvironment,
windowAccessor: WindowAccessor = () => globalThis.window,
noopLoggerFactory: LoggerCreationFunction = () => new NoopLogger(),
windowInjectedLoggerFactory: LoggerCreationFunction = () => new WindowInjectedLogger(),
consoleLoggerFactory: LoggerCreationFunction = () => new ConsoleLogger(),
) { ) {
if (isUnitOrIntegrationTests(environment, windowAccessor)) {
this.logger = noopLoggerFactory(); // keep the test outputs clean
return;
}
if (environment.isDesktop) { if (environment.isDesktop) {
this.logger = new WindowInjectedLogger(); this.logger = windowInjectedLoggerFactory();
return; return;
} }
if (environment.isNonProduction) { if (environment.isNonProduction) {
this.logger = new ConsoleLogger(); this.logger = consoleLoggerFactory();
return; return;
} }
this.logger = new NoopLogger(); this.logger = noopLoggerFactory();
} }
} }
export type WindowAccessor = () => OptionalWindow;
export type LoggerCreationFunction = () => Logger;
type OptionalWindow = Window | undefined | null;
function isUnitOrIntegrationTests(
environment: RuntimeEnvironment,
windowAccessor: WindowAccessor,
): boolean {
/*
In a desktop application context, Electron preloader process inject a logger into
the global window object. If we're in a desktop (Node) environment and the logger isn't
injected, it indicates a testing environment.
*/
return environment.isDesktop && !windowAccessor()?.log;
}

View File

@@ -26,7 +26,10 @@ export default defineComponent({
async function executeCode() { async function executeCode() {
if (!codeRunner) { throw new Error('missing code runner'); } if (!codeRunner) { throw new Error('missing code runner'); }
await codeRunner.runCode(currentContext.state.code.current); await codeRunner.runCode(
currentContext.state.code.current,
currentContext.state.collection.scripting.fileExtension,
);
} }
return { return {

View File

@@ -21,6 +21,7 @@ import ModalDialog from '@/presentation/components/Shared/Modal/ModalDialog.vue'
import { IReadOnlyCategoryCollectionState } from '@/application/Context/State/ICategoryCollectionState'; import { IReadOnlyCategoryCollectionState } from '@/application/Context/State/ICategoryCollectionState';
import { ScriptingLanguage } from '@/domain/ScriptingLanguage'; import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
import { IScriptingDefinition } from '@/domain/IScriptingDefinition'; import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
import { ScriptFileName } from '@/application/CodeRunner/ScriptFileName';
import IconButton from '../IconButton.vue'; import IconButton from '../IconButton.vue';
import InstructionList from './Instructions/InstructionList.vue'; import InstructionList from './Instructions/InstructionList.vue';
import { IInstructionListData } from './Instructions/InstructionListData'; import { IInstructionListData } from './Instructions/InstructionListData';
@@ -74,11 +75,11 @@ function getType(language: ScriptingLanguage) {
throw new Error('unknown file type'); throw new Error('unknown file type');
} }
} }
function buildFileName(scripting: IScriptingDefinition) { function buildFileName(scripting: IScriptingDefinition) {
const fileName = 'privacy-script';
if (scripting.fileExtension) { if (scripting.fileExtension) {
return `${fileName}.${scripting.fileExtension}`; return `${ScriptFileName}.${scripting.fileExtension}`;
} }
return fileName; return ScriptFileName;
} }
</script> </script>

View File

@@ -1,5 +1,5 @@
import { ScriptFileCodeRunner } from '@/infrastructure/CodeRunner/ScriptFileCodeRunner'; import { ScriptFileCodeRunner } from '@/infrastructure/CodeRunner/ScriptFileCodeRunner';
import { CodeRunner } from '@/application/CodeRunner'; import { CodeRunner } from '@/application/CodeRunner/CodeRunner';
import { registerIpcChannel } from '../shared/IpcBridging/IpcProxy'; import { registerIpcChannel } from '../shared/IpcBridging/IpcProxy';
import { IpcChannelDefinitions } from '../shared/IpcBridging/IpcChannelDefinitions'; import { IpcChannelDefinitions } from '../shared/IpcBridging/IpcChannelDefinitions';

View File

@@ -8,7 +8,6 @@ import log from 'electron-log/main';
import installExtension, { VUEJS_DEVTOOLS } from 'electron-devtools-installer'; import installExtension, { VUEJS_DEVTOOLS } from 'electron-devtools-installer';
import { validateRuntimeSanity } from '@/infrastructure/RuntimeSanity/SanityChecks'; import { validateRuntimeSanity } from '@/infrastructure/RuntimeSanity/SanityChecks';
import { ElectronLogger } from '@/infrastructure/Log/ElectronLogger'; import { ElectronLogger } from '@/infrastructure/Log/ElectronLogger';
import { name } from '@/../package.json' assert { type: 'json' };
import { setupAutoUpdater } from './Update/UpdateInitializer'; import { setupAutoUpdater } from './Update/UpdateInitializer';
import { import {
APP_ICON_PATH, PRELOADER_SCRIPT_PATH, RENDERER_HTML_PATH, RENDERER_URL, APP_ICON_PATH, PRELOADER_SCRIPT_PATH, RENDERER_HTML_PATH, RENDERER_URL,
@@ -62,7 +61,6 @@ function createWindow() {
configureAppQuitBehavior(); configureAppQuitBehavior();
registerAllIpcChannels(); registerAllIpcChannels();
setAppName();
app.whenReady().then(async () => { app.whenReady().then(async () => {
if (isDevelopment) { if (isDevelopment) {
@@ -167,13 +165,3 @@ function configureAppQuitBehavior() {
}); });
} }
} }
function setAppName() {
/*
Set the app name in development mode to ensure correct userData path.
Without this, `app.getPath('userData')` defaults to 'Electron'.
*/
if (isDevelopment) {
app.setName(name); // Works only for Windows, unsolved for macOS.
}
}

View File

@@ -1,5 +1,5 @@
import { FunctionKeys } from '@/TypeHelpers'; import { FunctionKeys } from '@/TypeHelpers';
import { CodeRunner } from '@/application/CodeRunner'; import { CodeRunner } from '@/application/CodeRunner/CodeRunner';
import { IpcChannel } from './IpcChannel'; import { IpcChannel } from './IpcChannel';
export const IpcChannelDefinitions = { export const IpcChannelDefinitions = {

View File

@@ -0,0 +1,89 @@
import { mkdtemp } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
import { exec } from 'node:child_process';
import { describe, it } from 'vitest';
import { ScriptDirectoryProvider } from '@/infrastructure/CodeRunner/Creation/Directory/ScriptDirectoryProvider';
import { ScriptFileCreationOrchestrator } from '@/infrastructure/CodeRunner/Creation/ScriptFileCreationOrchestrator';
import { ScriptFileCodeRunner } from '@/infrastructure/CodeRunner/ScriptFileCodeRunner';
import { expectDoesNotThrowAsync } from '@tests/shared/Assertions/ExpectThrowsAsync';
import { CurrentEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
import { OperatingSystem } from '@/domain/OperatingSystem';
import { LinuxTerminalEmulator } from '@/infrastructure/CodeRunner/Execution/VisibleTerminalScriptFileExecutor';
describe('ScriptFileCodeRunner', () => {
it('executes simple script correctly', async ({ skip }) => {
// arrange
const currentOperatingSystem = CurrentEnvironment.os;
if (await shouldSkipTest(currentOperatingSystem)) {
skip();
}
const temporaryDirectoryProvider = createTemporaryDirectoryProvider();
const codeRunner = createCodeRunner(temporaryDirectoryProvider);
const args = getPlatformSpecificArguments(currentOperatingSystem);
// act
const act = () => codeRunner.runCode(...args);
// assert
await expectDoesNotThrowAsync(act);
});
});
function getPlatformSpecificArguments(
os: OperatingSystem | undefined,
): Parameters<ScriptFileCodeRunner['runCode']> {
switch (os) {
case undefined:
throw new Error('Operating system detection failed: Unable to identify the current platform.');
case OperatingSystem.Windows:
return [
[
'@echo off',
'echo Hello, World!',
'exit /b 0',
].join('\n'),
'bat',
];
case OperatingSystem.macOS:
case OperatingSystem.Linux:
return [
[
'#!/bin/bash',
'echo "Hello, World!"',
'exit 0',
].join('\n'),
'sh',
];
default:
throw new Error(`Platform not supported: The current operating system (${os}) is not compatible with this script execution.`);
}
}
function shouldSkipTest(
os: OperatingSystem | undefined,
): Promise<boolean> {
return new Promise((resolve) => {
if (os !== OperatingSystem.Linux) {
resolve(false);
}
exec(`which ${LinuxTerminalEmulator}`).on('close', (exitCode) => {
resolve(exitCode !== 0);
});
});
}
function createCodeRunner(directoryProvider: ScriptDirectoryProvider): ScriptFileCodeRunner {
return new ScriptFileCodeRunner(
undefined,
new ScriptFileCreationOrchestrator(undefined, undefined, directoryProvider),
);
}
function createTemporaryDirectoryProvider(): ScriptDirectoryProvider {
return {
provideScriptDirectory: async () => {
const temporaryDirectoryPathPrefix = join(tmpdir(), 'privacy-sexy-tests-');
const temporaryDirectoryFullPath = await mkdtemp(temporaryDirectoryPathPrefix);
return temporaryDirectoryFullPath;
},
};
}

View File

@@ -7,8 +7,12 @@
* non-nullable in the subsequent code. This can prevent potential type errors * non-nullable in the subsequent code. This can prevent potential type errors
* and enhance code safety and clarity. * and enhance code safety and clarity.
*/ */
export function expectExists<T>(value: T): asserts value is NonNullable<T> { export function expectExists<T>(value: T, errorMessage?: string): asserts value is NonNullable<T> {
if (value === null || value === undefined) { if (value === null || value === undefined) {
throw new Error('Expected value to exist'); throw new Error([
'Assertion failed: expected value is either null or undefined.',
'Expected a non-null and non-undefined value.',
...(errorMessage ? [errorMessage] : []),
].join('\n'));
} }
} }

View File

@@ -1,103 +0,0 @@
import { describe, it, expect } from 'vitest';
import { AllSupportedOperatingSystems, SupportedOperatingSystem } from '@tests/shared/TestCases/SupportedOperatingSystems';
import { OperatingSystem } from '@/domain/OperatingSystem';
import { formatAssertionMessage } from '@tests/shared/FormatAssertionMessage';
import { RuntimeEnvironmentStub } from '@tests/unit/shared/Stubs/RuntimeEnvironmentStub';
import { OsTimestampedFilenameGenerator } from '@/infrastructure/CodeRunner/Creation/Filename/OsTimestampedFilenameGenerator';
describe('OsTimestampedFilenameGenerator', () => {
describe('generateFilename', () => {
it('generates correct prefix', () => {
// arrange
const expectedPrefix = 'run';
// act
const filename = generateFilenamePartsForTesting();
// assert
expect(filename.prefix).to.equal(expectedPrefix);
});
it('generates correct timestamp', () => {
// arrange
const currentDate = '2023-01-01T12:00:00.000Z';
const expectedTimestamp = '2023-01-01_12-00-00';
const date = new Date(currentDate);
// act
const filename = generateFilenamePartsForTesting({ date });
// assert
expect(filename.timestamp).to.equal(expectedTimestamp, formatAssertionMessage[
`Generated file name: ${filename.generatedFileName}`
]);
});
describe('generates correct extension', () => {
const testScenarios: Record<SupportedOperatingSystem, string> = {
[OperatingSystem.Windows]: 'bat',
[OperatingSystem.Linux]: 'sh',
[OperatingSystem.macOS]: 'sh',
};
AllSupportedOperatingSystems.forEach((operatingSystem) => {
it(`on ${OperatingSystem[operatingSystem]}`, () => {
// arrange
const expectedExtension = testScenarios[operatingSystem];
// act
const filename = generateFilenamePartsForTesting({ operatingSystem });
// assert
expect(filename.extension).to.equal(expectedExtension, formatAssertionMessage[
`Generated file name: ${filename.generatedFileName}`
]);
});
});
});
describe('generates filename without extension for unknown OS', () => {
// arrange
const testScenarios: ReadonlyArray<{
readonly description: string;
readonly unknownOs?: OperatingSystem;
}> = [
{
description: 'unsupported OS',
unknownOs: 'Unsupported' as unknown as OperatingSystem,
},
{
description: 'undefined OS',
unknownOs: undefined,
},
];
testScenarios.forEach(({ description, unknownOs }) => {
it(description, () => {
// act
const filename = generateFilenamePartsForTesting({ operatingSystem: unknownOs });
// assert
expect(filename.extension).toBeUndefined();
});
});
});
});
});
interface TestFileNameComponents {
readonly prefix: string;
readonly timestamp: string;
readonly extension?: string;
readonly generatedFileName: string;
}
function generateFilenamePartsForTesting(testScenario?: {
operatingSystem?: OperatingSystem,
date?: Date,
}): TestFileNameComponents {
const date = testScenario?.date ?? new Date();
const sut = new OsTimestampedFilenameGenerator(
new RuntimeEnvironmentStub().withOs(testScenario?.operatingSystem),
);
const filename = sut.generateFilename(date);
const pattern = /^(?<prefix>[^-]+)-(?<timestamp>[^.]+)(?:\.(?<extension>[^.]+))?$/; // prefix-timestamp.extension
const match = filename.match(pattern);
if (!match?.groups?.prefix || !match?.groups?.timestamp) {
throw new Error(`Failed to parse prefix or timestamp: ${filename}`);
}
return {
generatedFileName: filename,
prefix: match.groups.prefix,
timestamp: match.groups.timestamp,
extension: match.groups.extension,
};
}

View File

@@ -0,0 +1,124 @@
import { describe, it, expect } from 'vitest';
import { formatAssertionMessage } from '@tests/shared/FormatAssertionMessage';
import { TimestampedFilenameGenerator } from '@/infrastructure/CodeRunner/Creation/Filename/TimestampedFilenameGenerator';
import { itEachAbsentStringValue } from '@tests/unit/shared/TestCases/AbsentTests';
describe('TimestampedFilenameGenerator', () => {
describe('generateFilename', () => {
describe('script name', () => {
it('uses correct script name', () => {
// arrange
const expectedScriptName = 'test-script';
// act
const filename = generateFilenamePartsForTesting({
scriptName: expectedScriptName,
});
// assert
expect(filename.scriptName).to.equal(expectedScriptName);
});
describe('error for missing script name', () => {
itEachAbsentStringValue((absentValue) => {
// arrange
const expectedError = 'Script name is required but not provided.';
// act
const act = () => generateFilenamePartsForTesting({
scriptName: absentValue,
});
// assert
expect(act).to.throw(expectedError);
}, { excludeNull: true, excludeUndefined: true });
});
});
it('generates expected timestamp', () => {
// arrange
const currentDate = '2023-01-01T12:00:00.000Z';
const expectedTimestamp = '2023-01-01_12-00-00';
const date = new Date(currentDate);
// act
const filename = generateFilenamePartsForTesting({ date });
// assert
expect(filename.timestamp).to.equal(expectedTimestamp, formatAssertionMessage[
`Generated file name: ${filename.generatedFilename}`
]);
});
describe('extension', () => {
it('uses correct extension', () => {
// arrange
const expectedExtension = 'sexy';
// act
const filename = generateFilenamePartsForTesting({ extension: expectedExtension });
// assert
expect(filename.extension).to.equal(expectedExtension, formatAssertionMessage[
`Generated file name: ${filename.generatedFilename}`
]);
});
describe('handles absent extension', () => {
itEachAbsentStringValue((absentExtension) => {
// arrange
const expectedExtension = undefined;
// act
const filename = generateFilenamePartsForTesting({ extension: absentExtension });
// assert
expect(filename.extension).to.equal(expectedExtension, formatAssertionMessage[
`Generated file name: ${filename.generatedFilename}`
]);
}, { excludeNull: true });
});
it('errors on dot-starting extension', () => {
// arrange
const invalidExtension = '.sexy';
const expectedError = 'File extension should not start with a dot.';
// act
const act = () => generateFilenamePartsForTesting({ extension: invalidExtension });
// assert
expect(act).to.throw(expectedError);
});
});
});
});
interface TestFileNameComponents {
readonly scriptName: string;
readonly timestamp: string;
readonly extension?: string;
readonly generatedFilename: string;
}
function generateFilenamePartsForTesting(testScenario?: {
readonly date?: Date,
readonly extension?: string,
readonly scriptName?: string,
}): TestFileNameComponents {
const date = testScenario?.date ?? new Date();
const sut = new TimestampedFilenameGenerator();
const filename = sut.generateFilename(
{
scriptName: testScenario?.scriptName ?? 'privacy-script',
scriptFileExtension: testScenario?.extension,
},
date,
);
return parseFilename(filename);
}
function parseFilename(generatedFilename: string): TestFileNameComponents {
const pattern = /^(?<timestamp>\d{4}-\d{2}-\d{2}_\d{2}-\d{2}-\d{2})-(?<scriptName>[^.]+?)(?:\.(?<extension>[^.]+))?$/;// timestamp-scriptName.extension
const match = generatedFilename.match(pattern);
function assertMatch(name: string, value: string | undefined): asserts value is string {
if (!value) {
throw new Error([
`Missing "${name}" match in generated filename.`,
`Generated filename: ${generatedFilename}`,
`Match object: ${JSON.stringify(match)}`,
].join('\n'));
}
}
assertMatch('script name', match?.groups?.scriptName);
assertMatch('timestamp', match?.groups?.timestamp);
return {
generatedFilename,
scriptName: match.groups.scriptName,
timestamp: match.groups.timestamp,
extension: match.groups.extension,
};
}

View File

@@ -11,6 +11,8 @@ import { FilenameGeneratorStub } from '@tests/unit/shared/Stubs/FilenameGenerato
import { SystemOperationsStub } from '@tests/unit/shared/Stubs/SystemOperationsStub'; import { SystemOperationsStub } from '@tests/unit/shared/Stubs/SystemOperationsStub';
import { SystemOperations } from '@/infrastructure/CodeRunner/System/SystemOperations'; import { SystemOperations } from '@/infrastructure/CodeRunner/System/SystemOperations';
import { LocationOpsStub } from '@tests/unit/shared/Stubs/LocationOpsStub'; import { LocationOpsStub } from '@tests/unit/shared/Stubs/LocationOpsStub';
import { ScriptFileNameParts } from '@/infrastructure/CodeRunner/Creation/ScriptFileCreator';
import { expectExists } from '@tests/shared/Assertions/ExpectExists';
describe('ScriptFileCreationOrchestrator', () => { describe('ScriptFileCreationOrchestrator', () => {
describe('createScriptFile', () => { describe('createScriptFile', () => {
@@ -62,6 +64,28 @@ describe('ScriptFileCreationOrchestrator', () => {
.pop(); .pop();
expect(actualFileName).to.equal(expectedFilename); expect(actualFileName).to.equal(expectedFilename);
}); });
it('generates file name using specified parts', async () => {
// arrange
const expectedParts: ScriptFileNameParts = {
scriptName: 'expected-script-name',
scriptFileExtension: 'expected-script-file-extension',
};
const filenameGeneratorStub = new FilenameGeneratorStub();
const context = new ScriptFileCreationOrchestratorTestSetup()
.withFileNameParts(expectedParts)
.withFilenameGenerator(filenameGeneratorStub);
// act
await context.createScriptFile();
// assert
const fileNameGenerationCalls = filenameGeneratorStub.callHistory.filter((c) => c.methodName === 'generateFilename');
expect(fileNameGenerationCalls).to.have.lengthOf(1);
const callArguments = fileNameGenerationCalls[0].args;
const [scriptNameFileParts] = callArguments;
expectExists(scriptNameFileParts, `Call arguments: ${JSON.stringify(callArguments)}`);
expect(scriptNameFileParts).to.equal(expectedParts);
});
it('generates complete file path', async () => { it('generates complete file path', async () => {
// arrange // arrange
const expectedPath = 'expected-script-path'; const expectedPath = 'expected-script-path';
@@ -84,7 +108,7 @@ describe('ScriptFileCreationOrchestrator', () => {
expect(actualFilePath).to.equal(expectedPath); expect(actualFilePath).to.equal(expectedPath);
}); });
}); });
describe('writing file to system', () => { describe('file writing', () => {
it('writes file to the generated path', async () => { it('writes file to the generated path', async () => {
// arrange // arrange
const filesystem = new FileSystemOpsStub(); const filesystem = new FileSystemOpsStub();
@@ -133,6 +157,11 @@ class ScriptFileCreationOrchestratorTestSetup {
private fileContents = `[${ScriptFileCreationOrchestratorTestSetup.name}] script file contents`; private fileContents = `[${ScriptFileCreationOrchestratorTestSetup.name}] script file contents`;
private fileNameParts: ScriptFileNameParts = {
scriptName: `[${ScriptFileCreationOrchestratorTestSetup.name}] script name`,
scriptFileExtension: `[${ScriptFileCreationOrchestratorTestSetup.name}] file extension`,
};
public withFileContents(fileContents: string): this { public withFileContents(fileContents: string): this {
this.fileContents = fileContents; this.fileContents = fileContents;
return this; return this;
@@ -153,6 +182,11 @@ class ScriptFileCreationOrchestratorTestSetup {
return this; return this;
} }
public withFileNameParts(fileNameParts: ScriptFileNameParts): this {
this.fileNameParts = fileNameParts;
return this;
}
public createScriptFile(): ReturnType<ScriptFileCreationOrchestrator['createScriptFile']> { public createScriptFile(): ReturnType<ScriptFileCreationOrchestrator['createScriptFile']> {
const creator = new ScriptFileCreationOrchestrator( const creator = new ScriptFileCreationOrchestrator(
this.system, this.system,
@@ -160,6 +194,6 @@ class ScriptFileCreationOrchestratorTestSetup {
this.directoryProvider, this.directoryProvider,
this.logger, this.logger,
); );
return creator.createScriptFile(this.fileContents); return creator.createScriptFile(this.fileContents, this.fileNameParts);
} }
} }

View File

@@ -55,7 +55,7 @@ describe('VisibleTerminalScriptFileExecutor', () => {
{ {
description: 'encloses path in quotes', description: 'encloses path in quotes',
filePath: 'file', filePath: 'file',
expectedCommand: '"file"', expectedCommand: 'PowerShell Start-Process -Verb RunAs -FilePath "file"',
}, },
], ],
[OperatingSystem.macOS]: [ [OperatingSystem.macOS]: [

View File

@@ -2,6 +2,7 @@ import { describe, it, expect } from 'vitest';
import { ScriptFileCodeRunner } from '@/infrastructure/CodeRunner/ScriptFileCodeRunner'; import { ScriptFileCodeRunner } from '@/infrastructure/CodeRunner/ScriptFileCodeRunner';
import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub'; import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub';
import { Logger } from '@/application/Common/Log/Logger'; import { Logger } from '@/application/Common/Log/Logger';
import { ScriptFileName } from '@/application/CodeRunner/ScriptFileName';
import { ScriptFileExecutor } from '@/infrastructure/CodeRunner/Execution/ScriptFileExecutor'; import { ScriptFileExecutor } from '@/infrastructure/CodeRunner/Execution/ScriptFileExecutor';
import { ScriptFileExecutorStub } from '@tests/unit/shared/Stubs/ScriptFileExecutorStub'; import { ScriptFileExecutorStub } from '@tests/unit/shared/Stubs/ScriptFileExecutorStub';
import { ScriptFileCreator } from '@/infrastructure/CodeRunner/Creation/ScriptFileCreator'; import { ScriptFileCreator } from '@/infrastructure/CodeRunner/Creation/ScriptFileCreator';
@@ -11,7 +12,7 @@ import { expectThrowsAsync } from '@tests/shared/Assertions/ExpectThrowsAsync';
describe('ScriptFileCodeRunner', () => { describe('ScriptFileCodeRunner', () => {
describe('runCode', () => { describe('runCode', () => {
it('executes the script file as expected', async () => { it('executes script file correctly', async () => {
// arrange // arrange
const expectedFilePath = 'expected script path'; const expectedFilePath = 'expected script path';
const fileExecutor = new ScriptFileExecutorStub(); const fileExecutor = new ScriptFileExecutorStub();
@@ -45,6 +46,41 @@ describe('ScriptFileCodeRunner', () => {
const [actualCode] = createCalls[0].args; const [actualCode] = createCalls[0].args;
expect(actualCode).to.equal(expectedCode); expect(actualCode).to.equal(expectedCode);
}); });
it('creates script file with provided extension', async () => {
// arrange
const expectedFileExtension = 'expected-file-extension';
const fileCreator = new ScriptFileCreatorStub();
const context = new CodeRunnerTestSetup()
.withFileCreator(fileCreator)
.withFileExtension(expectedFileExtension);
// act
await context.runCode();
// assert
const createCalls = fileCreator.callHistory.filter((call) => call.methodName === 'createScriptFile');
expect(createCalls.length).to.equal(1);
const [,scriptFileNameParts] = createCalls[0].args;
expectExists(scriptFileNameParts, JSON.stringify(`Call args: ${JSON.stringify(createCalls[0].args)}`));
expect(scriptFileNameParts.scriptFileExtension).to.equal(expectedFileExtension);
});
it('creates script file with provided name', async () => {
// arrange
const expectedScriptName = ScriptFileName;
const fileCreator = new ScriptFileCreatorStub();
const context = new CodeRunnerTestSetup()
.withFileCreator(fileCreator);
// act
await context.runCode();
// assert
const createCalls = fileCreator.callHistory.filter((call) => call.methodName === 'createScriptFile');
expect(createCalls.length).to.equal(1);
const [,scriptFileNameParts] = createCalls[0].args;
expectExists(scriptFileNameParts, JSON.stringify(`Call args: ${JSON.stringify(createCalls[0].args)}`));
expect(scriptFileNameParts.scriptName).to.equal(expectedScriptName);
});
describe('error handling', () => { describe('error handling', () => {
const testScenarios: ReadonlyArray<{ const testScenarios: ReadonlyArray<{
readonly description: string; readonly description: string;
@@ -52,7 +88,7 @@ describe('ScriptFileCodeRunner', () => {
readonly faultyContext: CodeRunnerTestSetup; readonly faultyContext: CodeRunnerTestSetup;
}> = [ }> = [
(() => { (() => {
const error = new Error('script file execution failed'); const error = new Error('Test Error: Script file execution intentionally failed for testing purposes.');
const executor = new ScriptFileExecutorStub(); const executor = new ScriptFileExecutorStub();
executor.executeScriptFile = () => { executor.executeScriptFile = () => {
throw error; throw error;
@@ -64,7 +100,7 @@ describe('ScriptFileCodeRunner', () => {
}; };
})(), })(),
(() => { (() => {
const error = new Error('script file creation failed'); const error = new Error('Test Error: Script file creation intentionally failed for testing purposes.');
const creator = new ScriptFileCreatorStub(); const creator = new ScriptFileCreatorStub();
creator.createScriptFile = () => { creator.createScriptFile = () => {
throw error; throw error;
@@ -76,7 +112,7 @@ describe('ScriptFileCodeRunner', () => {
}; };
})(), })(),
]; ];
describe('logs errors correctly', () => { describe('logs errors', () => {
testScenarios.forEach(({ description, faultyContext }) => { testScenarios.forEach(({ description, faultyContext }) => {
it(`logs error when ${description}`, async () => { it(`logs error when ${description}`, async () => {
// arrange // arrange
@@ -94,7 +130,7 @@ describe('ScriptFileCodeRunner', () => {
}); });
}); });
}); });
describe('correctly rethrows errors', () => { describe('rethrows errors', () => {
testScenarios.forEach(({ description, injectedException, faultyContext }) => { testScenarios.forEach(({ description, injectedException, faultyContext }) => {
it(`rethrows error when ${description}`, async () => { it(`rethrows error when ${description}`, async () => {
// act // act
@@ -111,6 +147,8 @@ describe('ScriptFileCodeRunner', () => {
class CodeRunnerTestSetup { class CodeRunnerTestSetup {
private code = `[${CodeRunnerTestSetup.name}]code`; private code = `[${CodeRunnerTestSetup.name}]code`;
private fileExtension = `[${CodeRunnerTestSetup.name}]file-extension`;
private fileCreator: ScriptFileCreator = new ScriptFileCreatorStub(); private fileCreator: ScriptFileCreator = new ScriptFileCreatorStub();
private fileExecutor: ScriptFileExecutor = new ScriptFileExecutorStub(); private fileExecutor: ScriptFileExecutor = new ScriptFileExecutorStub();
@@ -123,7 +161,7 @@ class CodeRunnerTestSetup {
this.fileCreator, this.fileCreator,
this.logger, this.logger,
); );
await runner.runCode(this.code); await runner.runCode(this.code, this.fileExtension);
} }
public withFileExecutor(fileExecutor: ScriptFileExecutor): this { public withFileExecutor(fileExecutor: ScriptFileExecutor): this {
@@ -145,4 +183,9 @@ class CodeRunnerTestSetup {
this.fileCreator = fileCreator; this.fileCreator = fileCreator;
return this; return this;
} }
public withFileExtension(fileExtension: string): this {
this.fileExtension = fileExtension;
return this;
}
} }

View File

@@ -1,7 +1,7 @@
import { describe, it, expect } from 'vitest'; import { describe, it, expect } from 'vitest';
import { import {
BrowserRuntimeEnvironmentFactory, NodeRuntimeEnvironmentFactory, BrowserRuntimeEnvironmentFactory, NodeRuntimeEnvironmentFactory,
WindowAccessor, determineAndCreateRuntimeEnvironment, GlobalAccessor as GlobalPropertiesAccessor, determineAndCreateRuntimeEnvironment,
} from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory'; } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
import { RuntimeEnvironmentStub } from '@tests/unit/shared/Stubs/RuntimeEnvironmentStub'; import { RuntimeEnvironmentStub } from '@tests/unit/shared/Stubs/RuntimeEnvironmentStub';
@@ -11,7 +11,7 @@ describe('RuntimeEnvironmentFactory', () => {
// arrange // arrange
const expectedEnvironment = new RuntimeEnvironmentStub(); const expectedEnvironment = new RuntimeEnvironmentStub();
const context = new RuntimeEnvironmentFactoryTestSetup() const context = new RuntimeEnvironmentFactoryTestSetup()
.withWindowAccessor(() => { return {} as Window; }) .withWindowAccessor(() => createWindowStub())
.withBrowserEnvironmentFactory(() => expectedEnvironment); .withBrowserEnvironmentFactory(() => expectedEnvironment);
// act // act
const actualEnvironment = context.buildEnvironment(); const actualEnvironment = context.buildEnvironment();
@@ -21,7 +21,7 @@ describe('RuntimeEnvironmentFactory', () => {
it('passes correct window to browser environment', () => { it('passes correct window to browser environment', () => {
// arrange // arrange
const expectedWindow = {} as Window; const expectedWindow = createWindowStub();
let actualWindow: Window | undefined; let actualWindow: Window | undefined;
const browserEnvironmentFactoryMock: BrowserRuntimeEnvironmentFactory = (providedWindow) => { const browserEnvironmentFactoryMock: BrowserRuntimeEnvironmentFactory = (providedWindow) => {
actualWindow = providedWindow; actualWindow = providedWindow;
@@ -41,18 +41,58 @@ describe('RuntimeEnvironmentFactory', () => {
const expectedEnvironment = new RuntimeEnvironmentStub(); const expectedEnvironment = new RuntimeEnvironmentStub();
const context = new RuntimeEnvironmentFactoryTestSetup() const context = new RuntimeEnvironmentFactoryTestSetup()
.withWindowAccessor(() => undefined) .withWindowAccessor(() => undefined)
.withProcessAccessor(() => createProcessStub())
.withNodeEnvironmentFactory(() => expectedEnvironment); .withNodeEnvironmentFactory(() => expectedEnvironment);
// act // act
const actualEnvironment = context.buildEnvironment(); const actualEnvironment = context.buildEnvironment();
// assert // assert
expect(actualEnvironment).to.equal(expectedEnvironment); expect(actualEnvironment).to.equal(expectedEnvironment);
}); });
it('uses node environment when window is present too', () => { // This allows running integration tests
// arrange
const expectedEnvironment = new RuntimeEnvironmentStub();
const context = new RuntimeEnvironmentFactoryTestSetup()
.withWindowAccessor(() => createWindowStub())
.withProcessAccessor(() => createProcessStub())
.withNodeEnvironmentFactory(() => expectedEnvironment);
// act
const actualEnvironment = context.buildEnvironment();
// assert
expect(actualEnvironment).to.equal(expectedEnvironment);
});
it('throws if both node and window are missing', () => {
// arrange
const expectedError = 'Unsupported runtime environment: The current context is neither a recognized browser nor a Node.js environment.';
const context = new RuntimeEnvironmentFactoryTestSetup()
.withWindowAccessor(() => undefined)
.withProcessAccessor(() => undefined);
// act
const act = () => context.buildEnvironment();
// assert
expect(act).to.throw(expectedError);
});
}); });
}); });
function createWindowStub(): Window {
return {} as Window;
}
function createProcessStub(): NodeJS.Process {
return {} as NodeJS.Process;
}
type WindowAccessor = GlobalPropertiesAccessor['getGlobalWindow'];
type ProcessAccessor = GlobalPropertiesAccessor['getGlobalProcess'];
export class RuntimeEnvironmentFactoryTestSetup { export class RuntimeEnvironmentFactoryTestSetup {
private windowAccessor: WindowAccessor = () => undefined; private windowAccessor: WindowAccessor = () => undefined;
private processAccessor: ProcessAccessor = () => undefined;
private browserEnvironmentFactory private browserEnvironmentFactory
: BrowserRuntimeEnvironmentFactory = () => new RuntimeEnvironmentStub(); : BrowserRuntimeEnvironmentFactory = () => new RuntimeEnvironmentStub();
@@ -64,6 +104,11 @@ export class RuntimeEnvironmentFactoryTestSetup {
return this; return this;
} }
public withProcessAccessor(processAccessor: ProcessAccessor): this {
this.processAccessor = processAccessor;
return this;
}
public withNodeEnvironmentFactory( public withNodeEnvironmentFactory(
nodeEnvironmentFactory: NodeRuntimeEnvironmentFactory, nodeEnvironmentFactory: NodeRuntimeEnvironmentFactory,
): this { ): this {
@@ -80,7 +125,10 @@ export class RuntimeEnvironmentFactoryTestSetup {
public buildEnvironment(): ReturnType<typeof determineAndCreateRuntimeEnvironment> { public buildEnvironment(): ReturnType<typeof determineAndCreateRuntimeEnvironment> {
return determineAndCreateRuntimeEnvironment( return determineAndCreateRuntimeEnvironment(
this.windowAccessor, {
getGlobalProcess: this.processAccessor,
getGlobalWindow: this.windowAccessor,
},
this.browserEnvironmentFactory, this.browserEnvironmentFactory,
this.nodeEnvironmentFactory, this.nodeEnvironmentFactory,
); );

View File

@@ -1,80 +1,159 @@
import { // eslint-disable-next-line max-classes-per-file
describe, it, beforeEach, afterEach, import { describe, it } from 'vitest';
} from 'vitest';
import { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment'; import { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
import { ClientLoggerFactory } from '@/presentation/bootstrapping/ClientLoggerFactory'; import { ClientLoggerFactory, LoggerCreationFunction, WindowAccessor } from '@/presentation/bootstrapping/ClientLoggerFactory';
import { Logger } from '@/application/Common/Log/Logger'; import { Logger } from '@/application/Common/Log/Logger';
import { WindowInjectedLogger } from '@/infrastructure/Log/WindowInjectedLogger';
import { ConsoleLogger } from '@/infrastructure/Log/ConsoleLogger';
import { NoopLogger } from '@/infrastructure/Log/NoopLogger';
import { RuntimeEnvironmentStub } from '@tests/unit/shared/Stubs/RuntimeEnvironmentStub'; import { RuntimeEnvironmentStub } from '@tests/unit/shared/Stubs/RuntimeEnvironmentStub';
import { Constructible } from '@/TypeHelpers';
import { itIsSingleton } from '@tests/unit/shared/TestCases/SingletonTests'; import { itIsSingleton } from '@tests/unit/shared/TestCases/SingletonTests';
import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub'; import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub';
describe('ClientLoggerFactory', () => { describe('ClientLoggerFactory', () => {
describe('Current', () => { describe('Current', () => {
describe('singleton behavior', () => {
itIsSingleton({ itIsSingleton({
getter: () => ClientLoggerFactory.Current, getter: () => ClientLoggerFactory.Current,
expectedType: ClientLoggerFactory, expectedType: ClientLoggerFactory,
}); });
}); });
});
describe('logger instantiation based on environment', () => { describe('logger instantiation based on environment', () => {
const originalWindow = { ...window };
beforeEach(() => {
Object.assign(window, { log: new LoggerStub() });
});
afterEach(() => {
Object.assign(window, originalWindow);
});
const testCases: Array<{ const testCases: Array<{
readonly description: string, readonly description: string,
readonly expectedType: Constructible<Logger>, readonly build: (
readonly environment: RuntimeEnvironment, builder: ClientLoggerFactoryBuilder,
expectedLogger: Logger,
) => ClientLoggerFactory,
}> = [ }> = [
{ {
description: 'desktop environment', description: 'production desktop environment',
expectedType: WindowInjectedLogger, build: (b, expectedLogger) => b
environment: new RuntimeEnvironmentStub() .withWindowInjectedLoggerFactory(() => expectedLogger)
.withIsDesktop(true), .withEnvironment(new RuntimeEnvironmentStub()
},
{
description: 'non-production and desktop environment',
expectedType: WindowInjectedLogger,
environment: new RuntimeEnvironmentStub()
.withIsDesktop(true) .withIsDesktop(true)
.withIsNonProduction(true), .withIsNonProduction(false))
.withWindowAccessor(() => createWindowWithLogger())
.build(),
}, },
{ {
description: 'non-production without desktop', description: 'non-production desktop environment',
expectedType: ConsoleLogger, build: (b, expectedLogger) => b
environment: new RuntimeEnvironmentStub() .withWindowInjectedLoggerFactory(() => expectedLogger)
.withIsDesktop(false) .withEnvironment(new RuntimeEnvironmentStub()
.withIsNonProduction(true), .withIsDesktop(true)
.withIsNonProduction(true))
.withWindowAccessor(() => createWindowWithLogger())
.build(),
}, },
{ {
description: 'production without desktop', description: 'non-production web environment',
expectedType: NoopLogger, build: (b, expectedLogger) => b
environment: new RuntimeEnvironmentStub() .withConsoleLoggerFactory(() => expectedLogger)
.withEnvironment(new RuntimeEnvironmentStub()
.withIsDesktop(false) .withIsDesktop(false)
.withIsNonProduction(false), .withIsNonProduction(true))
.withWindowAccessor(() => createWindowWithLogger())
.build(),
},
{
description: 'production web environment',
build: (b, expectedLogger) => b
.withNoopLoggerFactory(() => expectedLogger)
.withEnvironment(new RuntimeEnvironmentStub()
.withIsDesktop(false)
.withIsNonProduction(false))
.withWindowAccessor(() => createWindowWithLogger())
.build(),
},
{
description: 'unit/integration tests environment',
build: (b, expectedLogger) => b
.withNoopLoggerFactory(() => expectedLogger)
.withEnvironment(new RuntimeEnvironmentStub().withIsDesktop(true))
.withWindowAccessor(() => createWindowWithLogger(null))
.build(),
}, },
]; ];
testCases.forEach(({ description, expectedType, environment }) => { testCases.forEach(({ description, build }) => {
it(`instantiates ${expectedType.name} for ${description}`, () => { it(`creates correct logger for ${description}`, () => {
// arrange // arrange
const factory = new TestableClientLoggerFactory(environment); const expectedLogger = new LoggerStub();
const factory = build(new ClientLoggerFactoryBuilder(), expectedLogger);
// act // act
const { logger } = factory; const { logger } = factory;
// assert // assert
expect(logger).to.be.instanceOf(expectedType); expect(logger).to.equal(expectedLogger);
}); });
}); });
}); });
}); });
function createWindowWithLogger(logger: Logger | null = new LoggerStub()): Window {
return {
log: logger,
} as unknown as Window;
}
class ClientLoggerFactoryBuilder {
private environment: RuntimeEnvironment = new RuntimeEnvironmentStub();
private windowAccessor: WindowAccessor = () => ({} as Window);
private noopLoggerFactory: LoggerCreationFunction = () => new LoggerStub();
private windowInjectedLoggerFactory: LoggerCreationFunction = () => new LoggerStub();
private consoleLoggerFactory: LoggerCreationFunction = () => new LoggerStub();
public withWindowAccessor(windowAccessor: WindowAccessor): this {
this.windowAccessor = windowAccessor;
return this;
}
public withEnvironment(environment: RuntimeEnvironment): this {
this.environment = environment;
return this;
}
public withNoopLoggerFactory(factory: LoggerCreationFunction): this {
this.noopLoggerFactory = factory;
return this;
}
public withWindowInjectedLoggerFactory(factory: LoggerCreationFunction): this {
this.windowInjectedLoggerFactory = factory;
return this;
}
public withConsoleLoggerFactory(factory: LoggerCreationFunction): this {
this.consoleLoggerFactory = factory;
return this;
}
public build(): ClientLoggerFactory {
return new TestableClientLoggerFactory(
this.environment,
this.windowAccessor,
this.noopLoggerFactory,
this.windowInjectedLoggerFactory,
this.consoleLoggerFactory,
);
}
}
class TestableClientLoggerFactory extends ClientLoggerFactory { class TestableClientLoggerFactory extends ClientLoggerFactory {
public constructor(environment: RuntimeEnvironment) { public constructor(
super(environment); environment: RuntimeEnvironment,
windowAccessor: WindowAccessor,
noopLoggerFactory: LoggerCreationFunction,
windowInjectedLoggerFactory: LoggerCreationFunction,
consoleLoggerFactory: LoggerCreationFunction,
) {
super(
environment,
windowAccessor,
noopLoggerFactory,
windowInjectedLoggerFactory,
consoleLoggerFactory,
);
} }
} }

View File

@@ -1,4 +1,4 @@
import { CodeRunner } from '@/application/CodeRunner'; import { CodeRunner } from '@/application/CodeRunner/CodeRunner';
export class CodeRunnerStub implements CodeRunner { export class CodeRunnerStub implements CodeRunner {
public runCode(): Promise<void> { public runCode(): Promise<void> {

View File

@@ -1,9 +1,17 @@
import { FilenameGenerator } from '@/infrastructure/CodeRunner/Creation/Filename/FilenameGenerator'; import { FilenameGenerator } from '@/infrastructure/CodeRunner/Creation/Filename/FilenameGenerator';
import { ScriptFileNameParts } from '@/infrastructure/CodeRunner/Creation/ScriptFileCreator';
import { StubWithObservableMethodCalls } from './StubWithObservableMethodCalls';
export class FilenameGeneratorStub implements FilenameGenerator { export class FilenameGeneratorStub
extends StubWithObservableMethodCalls<FilenameGenerator>
implements FilenameGenerator {
private filename = `[${FilenameGeneratorStub.name}]file-name-stub`; private filename = `[${FilenameGeneratorStub.name}]file-name-stub`;
public generateFilename(): string { public generateFilename(scriptFileNameParts: ScriptFileNameParts): string {
this.registerMethodCall({
methodName: 'generateFilename',
args: [scriptFileNameParts],
});
return this.filename; return this.filename;
} }

View File

@@ -1,4 +1,4 @@
import { ScriptFileCreator } from '@/infrastructure/CodeRunner/Creation/ScriptFileCreator'; import { ScriptFileCreator, ScriptFileNameParts } from '@/infrastructure/CodeRunner/Creation/ScriptFileCreator';
import { StubWithObservableMethodCalls } from './StubWithObservableMethodCalls'; import { StubWithObservableMethodCalls } from './StubWithObservableMethodCalls';
export class ScriptFileCreatorStub export class ScriptFileCreatorStub
@@ -11,10 +11,13 @@ export class ScriptFileCreatorStub
return this; return this;
} }
public createScriptFile(contents: string): Promise<string> { public createScriptFile(
contents: string,
scriptFileNameParts: ScriptFileNameParts,
): Promise<string> {
this.registerMethodCall({ this.registerMethodCall({
methodName: 'createScriptFile', methodName: 'createScriptFile',
args: [contents], args: [contents, scriptFileNameParts],
}); });
return Promise.resolve(this.createdFilePath); return Promise.resolve(this.createdFilePath);
} }

View File

@@ -1,7 +1,7 @@
import { OperatingSystem } from '@/domain/OperatingSystem'; import { OperatingSystem } from '@/domain/OperatingSystem';
import { Logger } from '@/application/Common/Log/Logger'; import { Logger } from '@/application/Common/Log/Logger';
import { WindowVariables } from '@/infrastructure/WindowVariables/WindowVariables'; import { WindowVariables } from '@/infrastructure/WindowVariables/WindowVariables';
import { CodeRunner } from '@/application/CodeRunner'; import { CodeRunner } from '@/application/CodeRunner/CodeRunner';
import { LoggerStub } from './LoggerStub'; import { LoggerStub } from './LoggerStub';
import { CodeRunnerStub } from './CodeRunnerStub'; import { CodeRunnerStub } from './CodeRunnerStub';