Merge pull request #1 from paper-spa/url_parts

Add outputs for origin, host, and base path

action.yml

@@ -10,4 +10,10 @@ inputs:
     required: true
 outputs:
   base_url:
-    description: 'URL to deployed GitHub Pages'
+    description: 'GitHub Pages site full base URL. Examples: "https://octocat.github.io/my-repo/", "https://octocat.github.io/", "https://www.example.com/"'
+  origin:
+    description: 'GitHub Pages site origin. Examples: "https://octocat.github.io", "https://www.example.com"'
+  host:
+    description: 'GitHub Pages site host. Examples: "octocat.github.io", "www.example.com"'
+  base_path:
+    description: 'GitHub Pages site full base path. Examples: "/my-repo/" or "/"'

src/get-pages-base-url.js

@@ -0,0 +1,33 @@
+const core = require('@actions/core')
+const axios = require('axios')
+
+async function getPagesBaseUrl({ repositoryNwo, githubToken}) {
+  try {
+    const pagesEndpoint = `https://api.github.com/repos/${repositoryNwo}/pages`
+
+    core.info(`Get the Base URL to the page with endpoint ${pagesEndpoint}`)
+    const response = await axios.get(
+      pagesEndpoint,
+      {
+        headers: {
+          Accept: 'application/vnd.github.v3+json',
+          Authorization: `Bearer ${githubToken}`
+        }
+      }
+    )
+
+    pageObject = response.data
+    core.info(JSON.stringify(pageObject))
+
+    const siteUrl = new URL(pageObject.html_url)
+    core.setOutput('base_url', siteUrl.href)
+    core.setOutput('origin', siteUrl.origin)
+    core.setOutput('host', siteUrl.host)
+    core.setOutput('base_path', siteUrl.pathname)
+  } catch (error) {
+    core.error('Get on the Page failed', error)
+    throw error
+  }
+}
+
+module.exports = getPagesBaseUrl

src/get-pages-base-url.test.js

@@ -0,0 +1,68 @@
+const core = require('@actions/core')
+const axios = require('axios')
+//const { expect, jest } = require('@jest/globals')
+
+const getPagesBaseUrl = require('./get-pages-base-url')
+
+describe('getPagesBaseUrl', () => {
+  const GITHUB_REPOSITORY = 'paper-spa/is-awesome'
+  const GITHUB_TOKEN = 'gha-token'
+
+  beforeEach(() => {
+    jest.restoreAllMocks()
+
+    jest.spyOn(core, 'setOutput').mockImplementation((key, value) => { key, value })
+    jest.spyOn(core, 'setFailed').mockImplementation(param => param)
+
+    // Mock error/warning/info/debug
+    jest.spyOn(core, 'error').mockImplementation(jest.fn())
+    jest.spyOn(core, 'warning').mockImplementation(jest.fn())
+    jest.spyOn(core, 'info').mockImplementation(jest.fn())
+    jest.spyOn(core, 'debug').mockImplementation(jest.fn())
+  })
+
+  it('gets expected outputs for profile site', async () => {
+    const baseUrl = 'https://octocat.github.io/'
+
+    jest
+      .spyOn(axios, 'get')
+      .mockImplementationOnce(() => Promise.resolve({ data: { html_url: baseUrl } }))
+
+    await getPagesBaseUrl({ repositoryNwo: GITHUB_REPOSITORY, githubToken: GITHUB_TOKEN })
+
+    expect(core.setOutput).toHaveBeenCalledWith('base_url', baseUrl)
+    expect(core.setOutput).toHaveBeenCalledWith('origin', 'https://octocat.github.io')
+    expect(core.setOutput).toHaveBeenCalledWith('host', 'octocat.github.io')
+    expect(core.setOutput).toHaveBeenCalledWith('base_path', '/')
+  })
+
+  it('gets expected outputs for project site', async () => {
+    const baseUrl = 'https://octocat.github.io/my-repo/'
+
+    jest
+      .spyOn(axios, 'get')
+      .mockImplementationOnce(() => Promise.resolve({ data: { html_url: baseUrl } }))
+
+    await getPagesBaseUrl({ repositoryNwo: GITHUB_REPOSITORY, githubToken: GITHUB_TOKEN })
+
+    expect(core.setOutput).toHaveBeenCalledWith('base_url', baseUrl)
+    expect(core.setOutput).toHaveBeenCalledWith('origin', 'https://octocat.github.io')
+    expect(core.setOutput).toHaveBeenCalledWith('host', 'octocat.github.io')
+    expect(core.setOutput).toHaveBeenCalledWith('base_path', '/my-repo/')
+  })
+
+  it('gets expected outputs for site with custom domain name', async () => {
+    const baseUrl = 'https://www.example.com/'
+
+    jest
+      .spyOn(axios, 'get')
+      .mockImplementationOnce(() => Promise.resolve({ data: { html_url: baseUrl } }))
+
+    await getPagesBaseUrl({ repositoryNwo: GITHUB_REPOSITORY, githubToken: GITHUB_TOKEN })
+
+    expect(core.setOutput).toHaveBeenCalledWith('base_url', baseUrl)
+    expect(core.setOutput).toHaveBeenCalledWith('origin', 'https://www.example.com')
+    expect(core.setOutput).toHaveBeenCalledWith('host', 'www.example.com')
+    expect(core.setOutput).toHaveBeenCalledWith('base_path', '/')
+  })
+})

src/index.js

@@ -1,43 +1,16 @@
 const core = require('@actions/core')
-const axios = require('axios')
+
+const getPagesBaseUrl = require('./get-pages-base-url')
 
 // All variables we need from the runtime are loaded here
 const getContext = require('./context')
 
-async function getPageBaseUrl() {
-  try {
-    const context = getContext()
-
-    const pagesEndpoint = `https://api.github.com/repos/${context.repositoryNwo}/pages`
-
-    core.info("GITHUB_TOKEN : " + context.githubToken)
-
-    const response = await axios.get(
-      pagesEndpoint,
-      {
-        headers: {
-          Accept: 'application/vnd.github.v3+json',
-          Authorization: `Bearer ${context.githubToken}`
-        }
-      }
-    )
-
-    pageObject = response.data
-    core.info(JSON.stringify(pageObject))
-    core.setOutput('base_url', pageObject.html_url)
-    core.info(`Get the Base URL to the page with endpoint ${pagesEndpoint}`)
-  } catch (e) {
-    console.info('Get on the Page failed', e)
-    process.exit(1)
-  }
-}
-
-
 async function main() {
   try {
-    await getPageBaseUrl()
+    await getPagesBaseUrl(context)
   } catch (error) {
     core.setFailed(error)
+    process.exit(1)
   }
 }