Files
windmill/cli/test/override_settings_behavior.test.ts
T
Ruben Fiszel a22d179903 add GitHub Actions CI and raw app sync tests (#7677)
* feat(cli): add GitHub Actions CI and raw app sync tests

- Add CLI tests GitHub Action that runs on Linux and Windows
- Add build check job that runs on CLI and openapi.yaml changes
- Uses Rust cargo backend instead of Docker for better CI compatibility
- Add cargo_backend.ts and test_backend.ts for test infrastructure
- Fix Windows path separator bug in raw_apps.ts (use "/" for relative paths)
- Fix PostgreSQL URL parsing in cargo_backend.ts
- Update tests to use gitBranches format instead of deprecated overrides
- Add raw_app_sync.test.ts for raw app sync workflow testing (ignored for now - needs EE)
- Skip tests that require EE features (git sync settings, raw apps)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(cli): Fix Windows path compatibility issues in tests

- Use fromFileUrl() in cargo_backend.ts for proper Windows path handling
- Normalize path separators to forward slashes in resource_folders.ts
- Fix readDirRecursive to return normalized paths in test helper
- Use forward slashes consistently in buildMetadataPath and detection functions

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(cli): Use SEP in test assertions instead of modifying logic

- Revert resource_folders.ts to use SEP as intended
- Update test assertions to use SEP for platform-specific paths
- Keep readDirRecursive normalization for consistent test comparisons

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(cli): Use SEP for all path separators in test assertions

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(cli): Use resolve() for proper cross-platform path handling in cargo_backend

String concatenation with path separators creates malformed paths on Windows.
Use path.resolve() instead for proper cross-platform path resolution.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(backend): Add cfg attributes for Windows compatibility

- Add #[cfg(unix)] to anyhow::anyhow import (only used in unix cfg block)
- Add #[cfg(not(windows))] to parse_file function (uses cat, only for cgroups)
- Remove unused std::io import, use std::io::Result directly

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: Windows compilation + convert integration tests to withTestBackend

- Fix unused import SYSTEM_ROOT in csharp_executor.rs on Windows by
  requiring both windows and csharp feature
- Fix unused variable id in handle_child.rs on Windows by adding
  #[allow(unused_variables)] since id is only used in cfg(unix) code
- Convert all RUN_INTEGRATION_TESTS dependent tests in sync_pull_push.test.ts
  to use withTestBackend pattern for automatic backend setup

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat: configurable test features with CI_MINIMAL_FEATURES env var

- Default: full features (zip, private, enterprise) for local development
- CI mode: minimal features (zip only) when CI_MINIMAL_FEATURES=true
- Add shouldSkipOnCI() helper for tests requiring EE features
- Update EE-dependent tests to use shouldSkipOnCI()
- Add test instructions to cli/README.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: enable raw app tests (not EE-dependent)

Raw apps work with minimal features. 2 tests pass, 2 have test logic
bugs to investigate separately:
- "delete file and push" - file deletion not syncing correctly
- "dry-run push shows expected changes" - JSON output parsing issue

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: gate cgroups module to Linux only

cgroups are Linux-specific, the module was causing dead_code warnings
on Windows compilation.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(ci): add CI_MINIMAL_FEATURES env var to CLI tests workflow

Set CI_MINIMAL_FEATURES=true in both Linux and Windows test jobs so
the backend compiles with minimal features (zip only) and EE-dependent
tests self-skip via shouldSkipOnCI().

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(cli): raw app tests and backend startup timing

- Add 5s delay after backend ready for migrations to complete
- Fix dry-run JSON output parsing (handle pretty-printed JSON)
- Temporarily ignore "delete file" test (needs isSuperset fix)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(cli): raw app file deletion sync

- Add deepEqual check for files in raw_apps.ts isSuperset comparison
- Handle raw_app file deletions in sync.ts by re-pushing the entire app
- Fix test to remove CSS import before deleting the file

When deleting a file from a raw app, the sync now properly updates
the backend with the new file list (excluding the deleted file).

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(cli): Windows path separators in tests

Normalize paths for cross-platform comparison by converting
backslashes to forward slashes before path assertions.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(cli): normalize featurePaths in multi_instance_workspace test

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* test(cli): add mixed case paths sync tests for Windows compatibility

Add comprehensive tests for sync pull/push with capitalized folder paths
to catch Windows case-insensitivity issues:
- Scripts in f/MyFolder/MyScript
- Flows in f/MyFlows/DataProcessor
- Apps in f/MyApps/Dashboard
- Variables in f/MyVars/ApiKey
- Deeply nested paths with mixed case
- Multiple resources in same capitalized folder
- CamelCase folder names with numbers

Each test verifies the full pull -> modify -> push -> verify cycle.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* test(cli): add idempotency check to mixed case paths tests

After each push, pull again with --dry-run --json-output and verify
that no changes are detected. This ensures the sync is stable and
catches issues where pull/push cycles cause spurious diffs.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-25 20:38:33 +00:00

286 lines
9.8 KiB
TypeScript

import { assertEquals, assert } from "https://deno.land/std@0.224.0/assert/mod.ts";
import { getEffectiveSettings } from "../src/core/conf.ts";
import { withTestBackend } from "./test_backend.ts";
import { addWorkspace } from "../workspace.ts";
import { parseJsonFromCLIOutput } from "./test_config_helpers.ts";
// =============================================================================
// OVERRIDE SETTINGS BEHAVIOR TESTS
// Tests for gitBranches override inheritance and file filtering behavior
// =============================================================================
Deno.test({
name: "Override Settings: branch override inherits non-overridden settings from base config",
sanitizeResources: false,
sanitizeOps: false,
fn: async () => {
const config = {
includes: ["default/**"],
skipVariables: true, // Base has this as true
skipResources: true, // Base has this as true
skipApps: false, // Base has this as false
defaultTs: "bun" as const,
gitBranches: {
main: {
overrides: {
includes: ["override/**"],
skipApps: true // Override only changes skipApps, should inherit other skip flags
}
}
}
};
const effective = await getEffectiveSettings(
config,
undefined, // promotion
true, // skipBranchValidation
true, // suppressLogs
"main" // branchOverride
);
// Override values should be used
assertEquals(effective.includes, ["override/**"], "Must use override includes");
assertEquals(effective.skipApps, true, "Must use override skipApps");
// Should inherit skip flags from base config
assertEquals(effective.skipVariables, true, "Must inherit skipVariables=true from base config");
assertEquals(effective.skipResources, true, "Must inherit skipResources=true from base config");
assertEquals(effective.defaultTs, "bun", "Must inherit defaultTs from base config");
}
});
Deno.test({
name: "Override Settings: branch-specific settings take precedence",
sanitizeResources: false,
sanitizeOps: false,
fn: async () => {
const config = {
includes: ["default/**"],
skipVariables: false,
gitBranches: {
main: {
overrides: {
skipVariables: true,
includes: ["main/**"]
}
},
dev: {
overrides: {
skipVariables: false,
includes: ["dev/**"]
}
}
}
};
// Test main branch
const mainEffective = await getEffectiveSettings(
config,
undefined,
true,
true,
"main"
);
assertEquals(mainEffective.includes, ["main/**"], "Main branch must use its own includes");
assertEquals(mainEffective.skipVariables, true, "Main branch must use its own skipVariables");
// Test dev branch
const devEffective = await getEffectiveSettings(
config,
undefined,
true,
true,
"dev"
);
assertEquals(devEffective.includes, ["dev/**"], "Dev branch must use its own includes");
assertEquals(devEffective.skipVariables, false, "Dev branch must use its own skipVariables");
}
});
// =============================================================================
// INTEGRATION TESTS - File Filtering Behavior with gitBranches
// =============================================================================
Deno.test({
name: "Integration: sync pull with skipVariables branch override excludes variable files",
sanitizeResources: false,
sanitizeOps: false,
fn: async () => {
await withTestBackend(async (backend, tempDir) => {
// Set up workspace
const testWorkspace = {
remote: backend.baseUrl,
workspaceId: backend.workspace,
name: "skip_variables_test",
token: backend.token
};
await addWorkspace(testWorkspace, { force: true, configDir: backend.testConfigDir });
// Create wmill.yaml with gitBranches override that skips variables
await Deno.writeTextFile(`${tempDir}/wmill.yaml`, `defaultTs: bun
includes:
- "**"
skipVariables: false
gitBranches:
test_branch:
overrides:
skipVariables: true`);
// Run sync pull with --branch to force using test_branch config
const result = await backend.runCLICommand([
'sync', 'pull',
'--branch', 'test_branch',
'--dry-run',
'--json-output'
], tempDir);
assertEquals(result.code, 0, `Sync pull should succeed: ${result.stderr}`);
// Parse output and verify variable files are NOT included
const output = parseJsonFromCLIOutput(result.stdout);
const changePaths = (output.changes || []).map((c: any) => c.path);
const hasVariableFile = changePaths.some((path: string) => path.includes('.variable.yaml'));
assertEquals(hasVariableFile, false, "Variable files should NOT be included due to skipVariables override");
// Verify other files ARE included
const hasOtherFiles = changePaths.some((path: string) =>
!path.includes('.variable.yaml') && !path.includes('wmill.yaml')
);
assert(hasOtherFiles, `Other files should be included. Found paths: ${changePaths.join(', ')}`);
});
}
});
Deno.test({
name: "Integration: sync pull respects includes branch override for file filtering",
sanitizeResources: false,
sanitizeOps: false,
fn: async () => {
await withTestBackend(async (backend, tempDir) => {
// Set up workspace
const testWorkspace = {
remote: backend.baseUrl,
workspaceId: backend.workspace,
name: "includes_test",
token: backend.token
};
await addWorkspace(testWorkspace, { force: true, configDir: backend.testConfigDir });
// Create wmill.yaml with gitBranches override for includes
await Deno.writeTextFile(`${tempDir}/wmill.yaml`, `defaultTs: bun
includes:
- "**"
gitBranches:
restricted_branch:
overrides:
includes:
- "users/**"
- "groups/**"`);
// Run sync pull with --branch to use restricted includes
const result = await backend.runCLICommand([
'sync', 'pull',
'--branch', 'restricted_branch',
'--include-users',
'--include-groups',
'--dry-run',
'--json-output'
], tempDir);
assertEquals(result.code, 0, `Sync pull should succeed: ${result.stderr}`);
// Parse output
const output = parseJsonFromCLIOutput(result.stdout);
const changePaths = (output.changes || []).map((c: any) => c.path);
// Normalize paths for cross-platform comparison (Windows uses backslashes)
const normalizedPaths = changePaths.map((p: string) => p.replace(/\\/g, '/'));
// Verify users/groups are included
const hasUserFiles = normalizedPaths.some((path: string) => path.includes('users/'));
const hasGroupFiles = normalizedPaths.some((path: string) => path.includes('groups/'));
assert(hasUserFiles || hasGroupFiles, `User or group files should be included. Found: ${normalizedPaths.join(', ')}`);
// Verify f/** files are NOT included (due to restrictive includes)
const hasFolderFiles = normalizedPaths.some((path: string) => path.startsWith('f/'));
assertEquals(hasFolderFiles, false, `f/ files should NOT be included due to restrictive includes. Found: ${normalizedPaths.join(', ')}`);
});
}
});
Deno.test({
name: "Integration: different branches have different settings",
sanitizeResources: false,
sanitizeOps: false,
fn: async () => {
await withTestBackend(async (backend, tempDir) => {
// Set up workspace
const testWorkspace = {
remote: backend.baseUrl,
workspaceId: backend.workspace,
name: "multi_branch_test",
token: backend.token
};
await addWorkspace(testWorkspace, { force: true, configDir: backend.testConfigDir });
// Create wmill.yaml with different settings per branch
await Deno.writeTextFile(`${tempDir}/wmill.yaml`, `defaultTs: bun
includes:
- "**"
skipVariables: false
skipResources: false
gitBranches:
prod:
overrides:
skipVariables: true
skipResources: true
dev:
overrides:
skipVariables: false
skipResources: false`);
// Test prod branch - should skip variables and resources
const prodResult = await backend.runCLICommand([
'sync', 'pull',
'--branch', 'prod',
'--dry-run',
'--json-output'
], tempDir);
assertEquals(prodResult.code, 0, `Prod sync pull should succeed: ${prodResult.stderr}`);
const prodOutput = parseJsonFromCLIOutput(prodResult.stdout);
const prodPaths = (prodOutput.changes || []).map((c: any) => c.path);
const prodHasVariables = prodPaths.some((path: string) => path.includes('.variable.yaml'));
const prodHasResources = prodPaths.some((path: string) => path.includes('.resource.yaml'));
assertEquals(prodHasVariables, false, "Prod branch should skip variables");
assertEquals(prodHasResources, false, "Prod branch should skip resources");
// Test dev branch - should include variables and resources
const devResult = await backend.runCLICommand([
'sync', 'pull',
'--branch', 'dev',
'--dry-run',
'--json-output'
], tempDir);
assertEquals(devResult.code, 0, `Dev sync pull should succeed: ${devResult.stderr}`);
const devOutput = parseJsonFromCLIOutput(devResult.stdout);
const devPaths = (devOutput.changes || []).map((c: any) => c.path);
const devHasVariables = devPaths.some((path: string) => path.includes('.variable.yaml'));
const devHasResources = devPaths.some((path: string) => path.includes('.resource.yaml'));
assertEquals(devHasVariables, true, "Dev branch should include variables");
assertEquals(devHasResources, true, "Dev branch should include resources");
});
}
});