fix: e2e tests run in CI, pin e2e workflow deps

coopernetes · coopernetes · commit 1e60ef58d499 · 2025-08-22T14:28:04.000-04:00
- Remove verbose logging from Dockerfile
- pin dependent actions in new e2e workflow to their respective commits
- refactor the tests to work slightly more robustly (handle creds, etc)
diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml
@@ -26,43 +26,43 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4
         with:
           # When triggered by comment, checkout the PR branch
           ref: ${{ github.event_name == 'issue_comment' && format('refs/pull/{0}/head', github.event.issue.number) || github.ref }}
 
-      - name: Add reaction to comment
-        if: github.event_name == 'issue_comment'
-        uses: peter-evans/create-or-update-comment@v4
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          comment-id: ${{ github.event.comment.id }}
-          reactions: eyes
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435
+
+      - name: Set up Docker Compose
+        uses: docker/setup-compose-action@364cc21a5de5b1ee4a7f5f9d3fa374ce0ccde746
 
       - name: Set up Node.js
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
-          node-version: '18'
+          node-version: '20'
           cache: 'npm'
 
       - name: Install dependencies
         run: npm ci
 
+      - name: Configure Git for CI
+        run: |
+          git config --global user.name "CI Runner"
+          git config --global user.email "ci@example.com"
+          git config --global init.defaultBranch main
+
       - name: Build and start services with Docker Compose
-        run: docker-compose up -d --build
+        run: docker compose up -d --build
 
       - name: Wait for services to be ready
         run: |
-          timeout 60 bash -c 'until docker-compose ps | grep -q "Up"; do sleep 2; done'
+          timeout 60 bash -c 'until docker compose ps | grep -q "Up"; do sleep 2; done'
           sleep 10
 
       - name: Run E2E tests
         run: npm run test:e2e
-        env:
-          GIT_PROXY_URL: http://localhost:8000
-          GIT_PROXY_UI_URL: http://localhost:8081
-          E2E_TIMEOUT: 30000
 
       - name: Stop services
         if: always()
-        run: docker-compose down -v
+        run: docker compose down -v
diff --git a/Dockerfile b/Dockerfile
@@ -9,20 +9,20 @@ WORKDIR /app
 COPY package*.json ./
 
 # Install all dependencies (including dev dependencies for building)
-RUN npm pkg delete scripts.prepare && npm ci --include=dev --loglevel verbose
+RUN npm pkg delete scripts.prepare && npm ci --include=dev
 
 # Copy source files and config files needed for build
 COPY tsconfig.json tsconfig.publish.json proxy.config.json config.schema.json integration-test.config.json vite.config.ts index.html index.ts ./
 COPY src/ /app/src/
 COPY public/ /app/public/
 
 # Build the UI and server
-RUN npm run build-ui --loglevel verbose \
+RUN npm run build-ui \
   && npx tsc --project tsconfig.publish.json \
   && cp config.schema.json dist/
 
 # Prune dev dependencies after build is complete  
-RUN npm prune --production
+RUN npm prune --omit=dev
 
 # Production stage
 FROM node:20-slim AS production
diff --git a/tests/e2e/fetch.test.ts b/tests/e2e/fetch.test.ts
@@ -1,6 +1,26 @@
+/**
+ * @license
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ * 
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
 import { describe, it, expect, beforeAll, afterAll } from 'vitest';
 import { execSync } from 'child_process';
-import { testConfig, waitForService, configureGitCredentials } from './setup';
+import { testConfig } from './setup';
 import fs from 'fs';
 import path from 'path';
 import os from 'os';
@@ -9,9 +29,6 @@ describe('Git Proxy E2E - Repository Fetch Tests', () => {
   const tempDir: string = path.join(os.tmpdir(), 'git-proxy-e2e-tests', Date.now().toString());
 
   beforeAll(async () => {
-    // Ensure the git proxy service is ready
-    await waitForService(`${testConfig.gitProxyUiUrl}/api/v1/healthcheck`);
-
     // Create temp directory for test clones
     fs.mkdirSync(tempDir, { recursive: true });
 
@@ -22,15 +39,16 @@ describe('Git Proxy E2E - Repository Fetch Tests', () => {
     it(
       'should successfully fetch coopernetes/test-repo through git proxy',
       async () => {
-        const repoUrl: string = `${testConfig.gitProxyUrl}/coopernetes/test-repo.git`;
+        // Build URL with embedded credentials for reliable authentication
+        const baseUrl = new URL(testConfig.gitProxyUrl);
+        baseUrl.username = testConfig.gitUsername;
+        baseUrl.password = testConfig.gitPassword;
+        const repoUrl = `${baseUrl.toString()}/coopernetes/test-repo.git`;
         const cloneDir: string = path.join(tempDir, 'test-repo-clone');
 
-        console.log(`Cloning ${repoUrl} to ${cloneDir}`);
+        console.log(`Cloning ${testConfig.gitProxyUrl}/coopernetes/test-repo.git to ${cloneDir}`);
 
         try {
-          // Configure git credentials locally in the temp directory
-          configureGitCredentials(tempDir);
-
           // Use git clone to fetch the repository through the proxy
           const gitCloneCommand: string = `git clone ${repoUrl} ${cloneDir}`;
           const output: string = execSync(gitCloneCommand, {
@@ -65,10 +83,14 @@ describe('Git Proxy E2E - Repository Fetch Tests', () => {
     it(
       'should successfully fetch finos/git-proxy through git proxy',
       async () => {
-        const repoUrl: string = `${testConfig.gitProxyUrl}/finos/git-proxy.git`;
+        // Build URL with embedded credentials for reliable authentication
+        const baseUrl = new URL(testConfig.gitProxyUrl);
+        baseUrl.username = testConfig.gitUsername;
+        baseUrl.password = testConfig.gitPassword;
+        const repoUrl = `${baseUrl.toString()}/finos/git-proxy.git`;
         const cloneDir: string = path.join(tempDir, 'git-proxy-clone');
 
-        console.log(`Cloning ${repoUrl} to ${cloneDir}`);
+        console.log(`Cloning ${testConfig.gitProxyUrl}/finos/git-proxy.git to ${cloneDir}`);
 
         try {
           const gitCloneCommand: string = `git clone ${repoUrl} ${cloneDir}`;
diff --git a/tests/e2e/push.test.ts b/tests/e2e/push.test.ts
@@ -1,6 +1,26 @@
+/**
+ * @license
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ * 
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
 import { describe, it, expect, beforeAll, afterAll } from 'vitest';
 import { execSync } from 'child_process';
-import { testConfig, waitForService, configureGitCredentials } from './setup';
+import { testConfig } from './setup';
 import fs from 'fs';
 import path from 'path';
 import os from 'os';
@@ -9,9 +29,6 @@ describe('Git Proxy E2E - Repository Push Tests', () => {
   const tempDir: string = path.join(os.tmpdir(), 'git-proxy-push-e2e-tests', Date.now().toString());
 
   beforeAll(async () => {
-    // Ensure the git proxy service is ready
-    await waitForService(`${testConfig.gitProxyUiUrl}/api/v1/healthcheck`);
-
     // Create temp directory for test clones
     fs.mkdirSync(tempDir, { recursive: true });
 
@@ -22,15 +39,18 @@ describe('Git Proxy E2E - Repository Push Tests', () => {
     it(
       'should handle push operations through git proxy (with proper authorization check)',
       async () => {
-        const repoUrl: string = `${testConfig.gitProxyUrl}/coopernetes/test-repo.git`;
+        // Build URL with embedded credentials for reliable authentication
+        const baseUrl = new URL(testConfig.gitProxyUrl);
+        baseUrl.username = testConfig.gitUsername;
+        baseUrl.password = testConfig.gitPassword;
+        const repoUrl = `${baseUrl.toString()}/coopernetes/test-repo.git`;
         const cloneDir: string = path.join(tempDir, 'test-repo-push');
 
-        console.log(`Testing push operation to ${repoUrl}`);
+        console.log(
+          `Testing push operation to ${testConfig.gitProxyUrl}/coopernetes/test-repo.git`,
+        );
 
         try {
-          // Configure git credentials for authentication
-          configureGitCredentials(tempDir);
-
           // Step 1: Clone the repository
           console.log('Step 1: Cloning repository...');
           const gitCloneCommand: string = `git clone ${repoUrl} ${cloneDir}`;
@@ -48,9 +68,6 @@ describe('Git Proxy E2E - Repository Push Tests', () => {
           expect(fs.existsSync(cloneDir)).toBe(true);
           expect(fs.existsSync(path.join(cloneDir, '.git'))).toBe(true);
 
-          // Configure git credentials in the cloned repository for push operations
-          configureGitCredentials(cloneDir);
-
           // Step 2: Make a dummy change
           console.log('Step 2: Creating dummy change...');
           const timestamp: string = new Date().toISOString();
diff --git a/tests/e2e/setup.ts b/tests/e2e/setup.ts
@@ -1,3 +1,23 @@
+/**
+ * @license
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ * 
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
 import { beforeAll } from 'vitest';
 
 // Environment configuration - can be overridden for different environments
@@ -26,18 +46,46 @@ export const testConfig = {
 export function configureGitCredentials(tempDir: string): void {
   const { execSync } = require('child_process');
 
-  // Configure git credentials using URL rewriting
-  const baseUrlParsed = new URL(testConfig.gitProxyBaseUrl);
-  const credentialUrl = `${baseUrlParsed.protocol}//${testConfig.gitUsername}:${testConfig.gitPassword}@${baseUrlParsed.host}${baseUrlParsed.pathname}`;
-  const insteadOfUrl = testConfig.gitProxyBaseUrl;
+  try {
+    // Configure git credentials using URL rewriting
+    const baseUrlParsed = new URL(testConfig.gitProxyBaseUrl);
 
-  execSync('git init', { cwd: tempDir, encoding: 'utf8' });
-  execSync(`git config url."${credentialUrl}".insteadOf ${insteadOfUrl}`, {
-    cwd: tempDir,
-    encoding: 'utf8',
-  });
+    // Initialize git if not already done
+    try {
+      execSync('git rev-parse --git-dir', { cwd: tempDir, encoding: 'utf8', stdio: 'pipe' });
+    } catch {
+      execSync('git init', { cwd: tempDir, encoding: 'utf8' });
+    }
 
-  console.log(`Configured git credentials for ${insteadOfUrl}`);
+    // Configure multiple URL patterns to catch all variations
+    const patterns = [
+      // Most important: the proxy server itself (this is what's asking for auth)
+      {
+        insteadOf: `${baseUrlParsed.protocol}//${baseUrlParsed.host}`,
+        credUrl: `${baseUrlParsed.protocol}//${testConfig.gitUsername}:${testConfig.gitPassword}@${baseUrlParsed.host}`,
+      },
+      // Base URL with trailing slash
+      {
+        insteadOf: testConfig.gitProxyBaseUrl,
+        credUrl: `${baseUrlParsed.protocol}//${testConfig.gitUsername}:${testConfig.gitPassword}@${baseUrlParsed.host}${baseUrlParsed.pathname}`,
+      },
+      // Base URL without trailing slash
+      {
+        insteadOf: testConfig.gitProxyBaseUrl.replace(/\/$/, ''),
+        credUrl: `${baseUrlParsed.protocol}//${testConfig.gitUsername}:${testConfig.gitPassword}@${baseUrlParsed.host}`,
+      },
+    ];
+
+    for (const pattern of patterns) {
+      execSync(`git config url."${pattern.credUrl}".insteadOf "${pattern.insteadOf}"`, {
+        cwd: tempDir,
+        encoding: 'utf8',
+      });
+    }
+  } catch (error) {
+    console.error('Failed to configure git credentials:', error);
+    throw error;
+  }
 }
 
 export async function waitForService(
@@ -78,9 +126,9 @@ beforeAll(async () => {
   console.log(`Git Username: ${testConfig.gitUsername}`);
   console.log(`Git Proxy Base URL: ${testConfig.gitProxyBaseUrl}`);
 
-  // Wait for the git proxy service to be ready
+  // Wait for the git proxy UI service to be ready
   // Note: Docker Compose should be started externally (e.g., in CI or manually)
-  await waitForService(`${testConfig.gitProxyUrl}/health`);
+  await waitForService(`${testConfig.gitProxyUiUrl}/api/v1/healthcheck`);
 
   console.log('E2E test environment is ready');
 }, testConfig.timeout);
