Add support for gitHubEnterprise git provider (#29)

* add support for gitHubEnterprise git provider * npm run all + fix tests
databricks · Nov 15, 2022 · e6748fd · e6748fd
1 parent 45ef7ec
commit e6748fd
Show file tree

Hide file tree

Showing 9 changed files with 45 additions and 12 deletions.
diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -234,13 +234,14 @@ describe(`main's runner integration tests`, () => {
     const dummyGitRepoName = 'dummyOwner/dummyRepo'
     const dummyGitServerUrl = 'github.com'
     const dummyGitCommit = 'sha1234'
+    const githubProvider = 'github'
     const expectedRunName = 'My python-notebook run'
     const dummyRunId = 123
     const dummyTaskRunId = 456
     const dummyRunUrl = 'databricks.com/url/to/job/run/'
     const expectedGitSourceSpec = {
       git_url: `${dummyGitServerUrl}/${dummyGitRepoName}`,
-      git_provider: 'github',
+      git_provider: githubProvider,
       git_commit: dummyGitCommit
     }
     const expectedParamsSpec = {
@@ -307,6 +308,7 @@ describe(`main's runner integration tests`, () => {
     process.env['INPUT_DATABRICKS-TOKEN'] = TOKEN
     process.env['INPUT_LOCAL-NOTEBOOK-PATH'] = notebookPath
     process.env['INPUT_GIT-COMMIT'] = dummyGitCommit
+    process.env['INPUT_GIT-PROVIDER'] = githubProvider
 
     process.env['INPUT_DATABRICKS-HOST'] = DATABRICKS_HOST
     process.env['INPUT_DATABRICKS-TOKEN'] = TOKEN

diff --git a/__tests__/utils.test.ts b/__tests__/utils.test.ts
@@ -320,11 +320,13 @@ describe(`input utils`, () => {
     beforeEach(() => {
       process.env['GITHUB_SERVER_URL'] = 'https://my-git.com'
       process.env['GITHUB_REPOSITORY'] = 'dummyOwner/dummyRepo'
+      process.env['INPUT_GIT-PROVIDER'] = 'gitHub'
     })
     afterEach(() => {
       delete process.env['INPUT_GIT-BRANCH']
       delete process.env['INPUT_GIT-TAG']
       delete process.env['INPUT_GIT-COMMIT']
+      delete process.env['INPUT_GIT-PROVIDER']
       delete process.env['GITHUB_SERVER_URL']
       delete process.env['GITHUB_REPOSITORY']
     })
@@ -350,7 +352,7 @@ describe(`input utils`, () => {
         git_source: {
           git_tag: expectedTag,
           git_url: 'https://my-git.com/dummyOwner/dummyRepo',
-          git_provider: 'github'
+          git_provider: 'gitHub'
         }
       })
     })
@@ -362,7 +364,7 @@ describe(`input utils`, () => {
         git_source: {
           git_branch: expectedBranch,
           git_url: 'https://my-git.com/dummyOwner/dummyRepo',
-          git_provider: 'github'
+          git_provider: 'gitHub'
         }
       })
     })
@@ -374,7 +376,22 @@ describe(`input utils`, () => {
         git_source: {
           git_commit: expectedCommit,
           git_url: 'https://my-git.com/dummyOwner/dummyRepo',
-          git_provider: 'github'
+          git_provider: 'gitHub'
+        }
+      })
+    })
+
+    test('git_provider is set in getGitSourceSpec correctly if non-default provider is passed as input', async () => {
+      var expectedCommit = 'my-commit'
+      var expectedProvider = 'gitHubEnterprise'
+      process.env['INPUT_GIT-COMMIT'] = expectedCommit
+      process.env['INPUT_GIT-PROVIDER'] = expectedProvider
+
+      expect(utils.getGitSourceSpec()).toEqual({
+        git_source: {
+          git_commit: expectedCommit,
+          git_url: 'https://my-git.com/dummyOwner/dummyRepo',
+          git_provider: expectedProvider
         }
       })
     })

diff --git a/action.yml b/action.yml
@@ -179,6 +179,17 @@ inputs:
       or REST API (https://docs.databricks.com/dev-tools/api/latest/workspace.html#export),
       rather than an arbitrary Python/Scala/R file.
     required: false
+  git-provider:
+    description: >
+      If specified, the notebook is run on Databricks within a temporary checkout of
+      the entire git repo using the specified git provider.
+      The local-notebook-path input as well as one of git-tag, git-commit, or git-branch must be specified when using this parameter,
+      and you must configure Git credentials (see https://docs.databricks.com/repos/index.html
+      #configure-your-git-integration-with-databricks).
+      The default value for this input is 'gitHub', but if the repository is hosted in Github enterprise
+      then one can specify 'gitHubEnterprise'.
+    required: false
+    default: 'gitHub'
 outputs:
   notebook-output:
     description: >

diff --git a/dist/main/index.js b/dist/main/index.js
diff --git a/dist/main/index.js.map b/dist/main/index.js.map
diff --git a/dist/post/index.js b/dist/post/index.js
diff --git a/dist/post/index.js.map b/dist/post/index.js.map
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "typescript-action",
-  "version": "0.0.0",
+  "version": "0.0.2",
   "private": true,
   "description": "TypeScript template action",
   "main": "lib/main.js",

diff --git a/packages/common/src/utils.ts b/packages/common/src/utils.ts
@@ -143,11 +143,12 @@ export const getGitSourceSpec = (): object => {
   const gitBranch: string = core.getInput('git-branch')
   const gitTag: string = core.getInput('git-tag')
   const gitCommit: string = core.getInput('git-commit')
+  const gitProvider: string = core.getInput('git-provider')
   const githubServerUrl: string = process.env['GITHUB_SERVER_URL'] || ''
   const githubRepo: string = process.env['GITHUB_REPOSITORY'] || ''
   const baseGitSourceSpec = {
     git_url: `${githubServerUrl}/${githubRepo}`,
-    git_provider: 'github'
+    git_provider: gitProvider
   }
 
   if (!isGitRefSpecified()) {