Merge pull request #1025 from jescalada/improve-plugin-test-coverage

test: improve proxy route test coverage

Author: JamieSlome

src/proxy/routes/index.ts

@@ -34,15 +34,21 @@ const stripGitHubFromGitPath = (url: string): string | undefined => {
  */
 const validGitRequest = (url: string, headers: any): boolean => {
   const { 'user-agent': agent, accept } = headers;
+  if (!agent) {
+    return false;
+  }
   if (['/info/refs?service=git-upload-pack', '/info/refs?service=git-receive-pack'].includes(url)) {
     // https://www.git-scm.com/docs/http-protocol#_discovering_references
     // We can only filter based on User-Agent since the Accept header is not
     // sent in this request
     return agent.startsWith('git/');
   }
   if (['/git-upload-pack', '/git-receive-pack'].includes(url)) {
+    if (!accept) {
+      return false;
+    }
     // https://www.git-scm.com/docs/http-protocol#_uploading_data
-    return agent.startsWith('git/') && accept.startsWith('application/x-git-');
+    return agent.startsWith('git/') && accept.startsWith('application/x-git-') ;
   }
   return false;
 };
@@ -67,7 +73,6 @@ router.use(
 
         if (action.error || action.blocked) {
           res.set('content-type', 'application/x-git-receive-pack-result');
-          res.set('transfer-encoding', 'chunked');
           res.set('expires', 'Fri, 01 Jan 1980 00:00:00 GMT');
           res.set('pragma', 'no-cache');
           res.set('cache-control', 'no-cache, max-age=0, must-revalidate');

test/testProxyRoute.js

@@ -0,0 +1,203 @@
+const { handleMessage, validGitRequest, stripGitHubFromGitPath } = require('../src/proxy/routes');
+const chai = require('chai');
+const chaiHttp = require('chai-http');
+const sinon = require('sinon');
+const express = require('express');
+const proxyRouter = require('../src/proxy/routes').router;
+const chain = require('../src/proxy/chain');
+
+chai.use(chaiHttp);
+chai.should();
+const expect = chai.expect;
+
+describe('proxy route filter middleware', () => {
+  let app;
+
+  beforeEach(() => {
+    app = express();
+    app.use('/', proxyRouter);
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  it('should reject invalid git requests with 400', async () => {
+    const res = await chai
+      .request(app)
+      .get('/owner/repo.git/invalid/path')
+      .set('user-agent', 'git/2.42.0')
+      .set('accept', 'application/x-git-upload-pack-request');
+
+    expect(res).to.have.status(400);
+    expect(res.text).to.equal('Invalid request received');
+  });
+
+  it('should handle blocked requests and return custom packet message', async () => {
+    sinon.stub(chain, 'executeChain').resolves({
+      blocked: true,
+      blockedMessage: 'You shall not push!',
+      error: true,
+    });
+
+    const res = await chai
+      .request(app)
+      .get('/owner/repo.git/info/refs?service=git-upload-pack')
+      .set('user-agent', 'git/2.42.0')
+      .set('accept', 'application/x-git-upload-pack-request')
+      .buffer();
+
+    expect(res.status).to.equal(200);
+    expect(res.text).to.contain('You shall not push!');
+    expect(res.headers['content-type']).to.include('application/x-git-receive-pack-result');
+    expect(res.headers['x-frame-options']).to.equal('DENY');
+  });
+
+  describe('when request is valid and not blocked', () => {
+    it('should return error if repo is not found', async () => {
+      sinon.stub(chain, 'executeChain').resolves({
+        blocked: false,
+        blockedMessage: '',
+        error: false,
+      });
+
+      const res = await chai
+        .request(app)
+        .get('/owner/repo.git/info/refs?service=git-upload-pack')
+        .set('user-agent', 'git/2.42.0')
+        .set('accept', 'application/x-git-upload-pack-request')
+        .buffer();
+
+      expect(res.status).to.equal(401);
+      expect(res.text).to.equal('Repository not found.');
+    });
+
+    it('should pass through if repo is found', async () => {
+      sinon.stub(chain, 'executeChain').resolves({
+        blocked: false,
+        blockedMessage: '',
+        error: false,
+      });
+
+      const res = await chai
+        .request(app)
+        .get('/finos/git-proxy.git/info/refs?service=git-upload-pack')
+        .set('user-agent', 'git/2.42.0')
+        .set('accept', 'application/x-git-upload-pack-request')
+        .buffer();
+
+      expect(res.status).to.equal(200);
+      expect(res.text).to.contain('git-upload-pack');
+    });
+  });
+});
+
+describe('proxy route helpers', () => {
+  describe('handleMessage', async () => {
+    it('should handle short messages', async function () {
+      const res = await handleMessage('one');
+      expect(res).to.contain('one');
+    });
+
+    it('should handle emoji messages', async function () {
+      const res = await handleMessage('❌ push failed: too many errors');
+      expect(res).to.contain('❌');
+    });
+  });
+
+  describe('validGitRequest', () => {
+    it('should return true for /info/refs?service=git-upload-pack with valid user-agent', () => {
+      const res = validGitRequest('/info/refs?service=git-upload-pack', {
+        'user-agent': 'git/2.30.1',
+      });
+      expect(res).to.be.true;
+    });
+  
+    it('should return true for /info/refs?service=git-receive-pack with valid user-agent', () => {
+      const res = validGitRequest('/info/refs?service=git-receive-pack', {
+        'user-agent': 'git/1.9.1',
+      });
+      expect(res).to.be.true;
+    });
+  
+    it('should return false for /info/refs?service=git-upload-pack with missing user-agent', () => {
+      const res = validGitRequest('/info/refs?service=git-upload-pack', {});
+      expect(res).to.be.false;
+    });
+  
+    it('should return false for /info/refs?service=git-upload-pack with non-git user-agent', () => {
+      const res = validGitRequest('/info/refs?service=git-upload-pack', {
+        'user-agent': 'curl/7.79.1',
+      });
+      expect(res).to.be.false;
+    });
+  
+    it('should return true for /git-upload-pack with valid user-agent and accept', () => {
+      const res = validGitRequest('/git-upload-pack', {
+        'user-agent': 'git/2.40.0',
+        accept: 'application/x-git-upload-pack-request',
+      });
+      expect(res).to.be.true;
+    });
+  
+    it('should return false for /git-upload-pack with missing accept header', () => {
+      const res = validGitRequest('/git-upload-pack', {
+        'user-agent': 'git/2.40.0',
+      });
+      expect(res).to.be.false;
+    });
+  
+    it('should return false for /git-upload-pack with wrong accept header', () => {
+      const res = validGitRequest('/git-upload-pack', {
+        'user-agent': 'git/2.40.0',
+        accept: 'application/json',
+      });
+      expect(res).to.be.false;
+    });
+  
+    it('should return false for unknown paths', () => {
+      const res = validGitRequest('/not-a-valid-git-path', {
+        'user-agent': 'git/2.40.0',
+        accept: 'application/x-git-upload-pack-request',
+      });
+      expect(res).to.be.false;
+    });
+  });
+
+  describe('stripGitHubFromGitPath', () => {
+    it('should strip owner and repo from a valid GitHub-style path with 4 parts', () => {
+      const res = stripGitHubFromGitPath('/foo/bar.git/info/refs');
+      expect(res).to.equal('/info/refs');
+    });
+  
+    it('should strip owner and repo from a valid GitHub-style path with 5 parts', () => {
+      const res = stripGitHubFromGitPath('/foo/bar.git/git-upload-pack');
+      expect(res).to.equal('/git-upload-pack');
+    });
+  
+    it('should return undefined for malformed path with too few segments', () => {
+      const res = stripGitHubFromGitPath('/foo/bar.git');
+      expect(res).to.be.undefined;
+    });
+  
+    it('should return undefined for malformed path with too many segments', () => {
+      const res = stripGitHubFromGitPath('/foo/bar.git/extra/path/stuff');
+      expect(res).to.be.undefined;
+    });
+  
+    it('should handle repo names that include dots correctly', () => {
+      const res = stripGitHubFromGitPath('/foo/some.repo.git/info/refs');
+      expect(res).to.equal('/info/refs');
+    });
+  
+    it('should not break if the path is just a slash', () => {
+      const res = stripGitHubFromGitPath('/');
+      expect(res).to.be.undefined;
+    });
+  
+    it('should not break if the path is empty', () => {
+      const res = stripGitHubFromGitPath('');
+      expect(res).to.be.undefined;
+    });
+  });
+});