feat(2676): Support passing in full path for getFile (#84)

Author: tkyi

index.js

@@ -10,6 +10,7 @@ const Path = require('path');
 const Url = require('url');
 const request = require('screwdriver-request');
 const schema = require('screwdriver-data-schema');
+const CHECKOUT_URL_REGEX = schema.config.regex.CHECKOUT_URL;
 const API_URL_V2 = 'https://api.bitbucket.org/2.0';
 const REPO_URL = `${API_URL_V2}/repositories`;
 const USER_URL = `${API_URL_V2}/users`;
@@ -49,8 +50,7 @@ function throwError(errorReason, errorCode = 500) {
  * @return  {Object}                    An object with hostname, repo, branch, and username
  */
 function getRepoInfo(checkoutUrl, rootDir) {
-    const regex = schema.config.regex.CHECKOUT_URL;
-    const matched = regex.exec(checkoutUrl);
+    const matched = CHECKOUT_URL_REGEX.exec(checkoutUrl);
 
     // Check if regex did not pass
     if (!matched) {
@@ -582,17 +582,35 @@ class BitbucketScm extends Scm {
      * @async getFile
      * @param  {Object}   config              Configuration
      * @param  {String}   config.scmUri       The scmUri
-     * @param  {String}   config.path         The file in the repo to fetch
+     * @param  {String}   config.path         The file in the repo to fetch or full checkout URL
      * @param  {String}   config.token        The token used to authenticate to the SCM
      * @param  {String}   [config.ref]        The reference to the SCM, either branch or sha
      * @return {Promise}                      Resolves to the content of the file
      */
     async _getFile({ scmUri, ref, path }) {
-        const { branch: branchFromScmUri, repoId, rootDir } = getScmUriParts(scmUri);
-        const branch = ref || branchFromScmUri;
-        const fullPath = rootDir ? Path.join(rootDir, path) : path;
-        const fileUrl = `${REPO_URL}/${repoId}/src/${branch}/${fullPath}`;
+        let fullPath = path;
+        let username;
+        let repo;
+        let branch;
+        let rootDir;
+        let repoId;
         const token = await this._getToken();
+
+        // If full path to a file is provided, e.g. git@github.com:screwdriver-cd/scm-github.git:path/to/a/file.yaml
+        if (CHECKOUT_URL_REGEX.test(path)) {
+            ({ username, repo, branch, rootDir } = getRepoInfo(fullPath));
+            fullPath = rootDir;
+            repoId = `${username}/${repo}`;
+        } else {
+            const scmUriParts = getScmUriParts(scmUri);
+
+            ({ repoId, rootDir } = scmUriParts);
+            branch = ref || scmUriParts.branch;
+
+            fullPath = rootDir ? Path.join(rootDir, path) : path;
+        }
+
+        const fileUrl = `${REPO_URL}/${repoId}/src/${branch}/${fullPath}`;
         const options = {
             url: fileUrl,
             method: 'GET',

package.json

@@ -35,8 +35,8 @@
     "debug": false
   },
   "devDependencies": {
-    "chai": "^4.3.4",
-    "eslint": "^7.5.0",
+    "chai": "^4.3.6",
+    "eslint": "^7.32.0",
     "eslint-config-screwdriver": "^5.0.1",
     "mocha": "^8.4.0",
     "mocha-multi-reporters": "^1.5.1",
@@ -46,11 +46,11 @@
     "sinon": "^9.0.0"
   },
   "dependencies": {
-    "@hapi/hoek": "^9.2.0",
-    "circuit-fuses": "^4.0.6",
-    "joi": "^17.2.1",
-    "screwdriver-data-schema": "^21.6.1",
-    "screwdriver-request": "^1.0.0",
-    "screwdriver-scm-base": "^7.2.1"
+    "@hapi/hoek": "^9.2.1",
+    "circuit-fuses": "^4.1.2",
+    "joi": "^17.6.0",
+    "screwdriver-data-schema": "^21.22.2",
+    "screwdriver-request": "^1.0.3",
+    "screwdriver-scm-base": "^7.4.0"
   }
 }

test/index.test.js

@@ -1004,6 +1004,22 @@ describe('index', function() {
             });
         });
 
+        it('resolves to correct commit sha with fullPath', () => {
+            scmUri = 'hostName:repoId:branchName:src/app/component';
+            params = {
+                scmUri,
+                token,
+                path: 'git@bitbucket.org:screwdriver-cd/reponame.git#main:path/to/file.txt'
+            };
+            expectedOptions.url =
+                'https://api.bitbucket.org/2.0/repositories/screwdriver-cd/reponame/src/main/path/to/file.txt';
+
+            return scm.getFile(params).then(content => {
+                assert.calledWith(requestMock, expectedOptions);
+                assert.deepEqual(content, 'dataValue');
+            });
+        });
+
         it('rejects if status code is not 200', () => {
             fakeResponse = {
                 statusCode: 404,