Refactor and add tests (#39)

Author: matt-richardson

README.md

@@ -1,28 +1,61 @@
 # TeamCityCloudAgentUpdater
 
-When a new TeamCity agent image is built (e.g., via [packer](packer.io)), you need to tell TeamCity to start using it. 
+When a new TeamCity agent image is built (e.g., via [packer](packer.io)), you need to tell TeamCity to start using it.
 
 This is a simple NodeJS app that can:
-1. update TeamCity Cloud Agents images and disable any agents that are running that are based on the old image
-2. remove any agents that were disabled during update that are no longer running a build
+1. Update TeamCity Cloud Agents images and disable any agents that are running that are based on the old image
+2. Remove any agents that were disabled during update that are no longer running a build
 
 ## Usage
 
 When you have a new agent, update the cloud profile:
-```
-node index.js [update-cloud-image] --token XXXXX --server https://teamcity.example.com --image ami-XXXXXXX --cloudprofile "AWS Agents" --agentprefix "Ubuntu" [--dryrun]
+```bash
+node index.js update-cloud-profile --token XXXXX --server https://teamcity.example.com --image ami-XXXXXXX --cloudprofile "AWS Agents" --agentprefix "Ubuntu" [--dryrun]
 ```
 
 To remove any agents that were disabled as part of the update, and are no longer running a build (run on a schedule):
-```
+```bash
 node index.js remove-disabled-agents --token XXXXX --server https://teamcity.example.com [--dryrun]
 ```
 
-The `--dryrun` flag allows you to check what actions the script would have taken with out any real modifications.
+The `--dryrun` flag allows you to check what actions the script would have taken without any real modifications.
+
+## Requirements
+
+- Node.js >= 22.0.0
+- npm >= 11.0.0
+- TeamCity `2019.1` or newer (for user access tokens)
+
+## Development
+
+### Installation
+```bash
+npm install
+```
+
+### Testing
+```bash
+# Run all tests
+npm test
+
+# Run tests in watch mode
+npm run test:watch
 
-## Requiremens
+# Run tests with coverage
+npm run test:coverage
+```
 
-This app uses features (user access tokens) that require TeamCity `2019.1` or newer.
+### Project Structure
+```
+.
+├── index.js                 # Entry point
+├── cli.js                   # CLI command definitions
+├── lib/
+│   ├── agents.js           # Agent management operations
+│   ├── cloud-profiles.js   # Cloud profile management
+│   └── utils.js            # Utility functions
+└── *.test.js               # Test files co-located with source
+```
 
 ## License
 

build.ps1

@@ -42,6 +42,94 @@ function Publish-ToGitHub($versionNumber, $commitId, $preRelease, $artifact, $gi
 Write-output "### Enabling TLS 1.2 support"
 [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls12, [System.Net.SecurityProtocolType]::Tls11, [System.Net.SecurityProtocolType]::Tls
 
+Write-output "### Running npm operations in Docker container"
+
+# Use Node 22 Alpine image (smaller and matches package.json requirement)
+$nodeImage = "node:22-alpine"
+$workDir = "/app"
+
+# Mount current directory to container and run npm/test commands
+Write-output "### Installing dependencies in Docker"
+docker run --rm `
+    -v "${PWD}:${workDir}" `
+    -w $workDir `
+    $nodeImage `
+    sh -c "npm install -g npm@latest && npm clean-install"
+
+if ($LASTEXITCODE -ne 0) {
+    Write-Error "npm clean-install failed with exit code $LASTEXITCODE"
+    exit $LASTEXITCODE
+}
+
+Write-output "### Running tests in Docker"
+# Run tests with Jest's TeamCity reporter if in TeamCity, otherwise use default reporter
+if ($env:TEAMCITY_VERSION) {
+    Write-output "##teamcity[testSuiteStarted name='Jest Tests']"
+
+    # Run tests with coverage (reporter auto-selected by jest.config.js)
+    docker run --rm `
+        -v "${PWD}:${workDir}" `
+        -w $workDir `
+        -e TEAMCITY_VERSION=$env:TEAMCITY_VERSION `
+        $nodeImage `
+        sh -c "npm install -g npm@latest && npx jest --coverage --ci"
+
+    $testExitCode = $LASTEXITCODE
+
+    # Report coverage to TeamCity if available
+    if (Test-Path "coverage/lcov.info") {
+        Write-output "### Reporting code coverage to TeamCity"
+
+        # Extract coverage metrics from lcov.info
+        $lcovContent = Get-Content "coverage/lcov.info"
+
+        # LF = Lines Found (total lines)
+        $totalLines = $lcovContent |
+            Select-String -Pattern "^LF:" |
+            ForEach-Object { [int]$_.Line.Split(':')[1] } |
+            Measure-Object -Sum |
+            Select-Object -ExpandProperty Sum
+
+        # LH = Lines Hit (covered lines)
+        $coveredLines = $lcovContent |
+            Select-String -Pattern "^LH:" |
+            ForEach-Object { [int]$_.Line.Split(':')[1] } |
+            Measure-Object -Sum |
+            Select-Object -ExpandProperty Sum
+
+        # Calculate percentage
+        if ($totalLines -gt 0) {
+            $coveragePercentage = [math]::Round(($coveredLines / $totalLines) * 100, 2)
+            Write-output "Code coverage: $coveredLines/$totalLines lines ($coveragePercentage%)"
+
+            # Report to TeamCity
+            Write-output "##teamcity[buildStatisticValue key='CodeCoverageAbsLTotal' value='$totalLines']"
+            Write-output "##teamcity[buildStatisticValue key='CodeCoverageAbsLCovered' value='$coveredLines']"
+            Write-output "##teamcity[buildStatisticValue key='CodeCoverageL' value='$coveragePercentage']"
+        }
+    }
+
+    Write-output "##teamcity[testSuiteFinished name='Jest Tests']"
+
+    if ($testExitCode -ne 0) {
+        Write-Error "Tests failed with exit code $testExitCode"
+        exit $testExitCode
+    }
+} else {
+    # Run tests normally when not in TeamCity
+    docker run --rm `
+        -v "${PWD}:${workDir}" `
+        -w $workDir `
+        $nodeImage `
+        sh -c "npm test"
+
+    if ($LASTEXITCODE -ne 0) {
+        Write-Error "Tests failed with exit code $LASTEXITCODE"
+        exit $LASTEXITCODE
+    }
+}
+
+Write-output "### Creating release archive"
 Compress-Archive -Path (get-childitem) -DestinationPath ".\TeamCityCloudAgentUpdater.$buildVersion.zip"
 
 $commitId = git rev-parse HEAD

cli.js

@@ -0,0 +1,42 @@
+'use strict';
+
+const { Command } = require('commander');
+const lib = require('./lib/index');
+
+function createProgram() {
+  const program = new Command();
+
+  program
+    .name('TeamCity Cloud Agent Updater')
+    .description('Simple NodeJS app to update images for TeamCity Cloud Agents, via the 2017.1 API.')
+    .version('1.0.0');
+
+  program
+    .command('update-cloud-profile', { isDefault: true })
+    .requiredOption('--token <string>', 'A valid TeamCity user access token (requires TC 2019.1)')
+    .requiredOption('--server <string>', 'The url of the TeamCity server, eg "http://teamcity.example.com"')
+    .requiredOption('--image <string>', 'The AMI id (for AWS), or full url to the VHD / resource id of the managed image (for Azure)')
+    .requiredOption('--cloudprofile <string>', 'The name of the TeamCity Cloud Profile to modify')
+    .requiredOption('--agentprefix <string>', 'The agent prefix used in the Cloud Profile image that should be updated')
+    .option('--dryrun', 'Output what changes the app would make, but dont actually make the changes')
+    .action((options) => lib.updateCloudImage(options.server, "Bearer " + options.token, options.cloudprofile, options.agentprefix, options.image, options.dryrun));
+
+  program
+    .command('remove-disabled-agents')
+    .requiredOption('--token <string>', 'A valid TeamCity user access token (requires TC 2019.1)')
+    .requiredOption('--server <string>', 'The url of the TeamCity server, eg "http://teamcity.example.com"')
+    .option('--dryrun', 'Output what changes the app would make, but dont actually make the changes')
+    .action((options) => lib.removeDisabledAgents(options.server, "Bearer " + options.token, options.dryrun));
+
+  return program;
+}
+
+function run(argv) {
+  const program = createProgram();
+  return program.parse(argv);
+}
+
+module.exports = {
+  createProgram,
+  run
+};

cli.test.js

@@ -0,0 +1,107 @@
+const { spawn } = require('child_process');
+const path = require('path');
+const cli = require('./cli');
+
+describe('CLI Commands', () => {
+  const indexPath = path.join(__dirname, 'index.js');
+
+  const runCommand = (args) => {
+    return new Promise((resolve, reject) => {
+      const process = spawn('node', [indexPath, ...args]);
+      let stdout = '';
+      let stderr = '';
+
+      process.stdout.on('data', (data) => {
+        stdout += data.toString();
+      });
+
+      process.stderr.on('data', (data) => {
+        stderr += data.toString();
+      });
+
+      process.on('close', (code) => {
+        resolve({ code, stdout, stderr });
+      });
+
+      process.on('error', (error) => {
+        reject(error);
+      });
+    });
+  };
+
+  describe('update-cloud-profile command', () => {
+    it('should show error when required options are missing', async () => {
+      const result = await runCommand(['update-cloud-profile']);
+      expect(result.code).not.toBe(0);
+      expect(result.stderr).toContain('required option');
+    });
+
+    it('should show help with --help flag', async () => {
+      const result = await runCommand(['update-cloud-profile', '--help']);
+      expect(result.code).toBe(0);
+      expect(result.stdout).toContain('--token');
+      expect(result.stdout).toContain('--server');
+      expect(result.stdout).toContain('--image');
+      expect(result.stdout).toContain('--cloudprofile');
+      expect(result.stdout).toContain('--agentprefix');
+      expect(result.stdout).toContain('--dryrun');
+    });
+
+    it('should validate required parameters', async () => {
+      const result = await runCommand([
+        'update-cloud-profile',
+        '--token', 'test-token'
+      ]);
+      expect(result.code).not.toBe(0);
+      expect(result.stderr).toContain('required option');
+    });
+  });
+
+  describe('remove-disabled-agents command', () => {
+    it('should show error when required options are missing', async () => {
+      const result = await runCommand(['remove-disabled-agents']);
+      expect(result.code).not.toBe(0);
+      expect(result.stderr).toContain('required option');
+    });
+
+    it('should show help with --help flag', async () => {
+      const result = await runCommand(['remove-disabled-agents', '--help']);
+      expect(result.code).toBe(0);
+      expect(result.stdout).toContain('--token');
+      expect(result.stdout).toContain('--server');
+      expect(result.stdout).toContain('--dryrun');
+    });
+
+    it('should validate required parameters', async () => {
+      const result = await runCommand([
+        'remove-disabled-agents',
+        '--token', 'test-token'
+      ]);
+      expect(result.code).not.toBe(0);
+      expect(result.stderr).toContain('required option');
+    });
+  });
+
+  describe('General CLI', () => {
+    it('should show version with --version flag', async () => {
+      const result = await runCommand(['--version']);
+      expect(result.code).toBe(0);
+      expect(result.stdout).toContain('1.0.0');
+    });
+
+    it('should show help with --help flag', async () => {
+      const result = await runCommand(['--help']);
+      expect(result.code).toBe(0);
+      expect(result.stdout).toContain('TeamCity Cloud Agent Updater');
+      expect(result.stdout).toContain('update-cloud-profile');
+      expect(result.stdout).toContain('remove-disabled-agents');
+    });
+
+    it('should use update-cloud-profile as default command', async () => {
+      const result = await runCommand([]);
+      expect(result.code).not.toBe(0);
+      // Should show error for missing required options from update-cloud-profile
+      expect(result.stderr).toContain('required option');
+    });
+  });
+});