@actions/artifact package (#304)

* Initial commit for @actions/artifact package

packages/artifact/__tests__/util.test.ts

@@ -0,0 +1,99 @@
+import * as utils from '../src/internal-utils'
+import * as core from '@actions/core'
+import {HttpCodes} from '@actions/http-client'
+import {getRuntimeUrl, getWorkFlowRunId} from '../src/internal-config-variables'
+
+jest.mock('../src/internal-config-variables')
+
+describe('Utils', () => {
+  beforeAll(() => {
+    // mock all output so that there is less noise when running tests
+    jest.spyOn(console, 'log').mockImplementation(() => {})
+    jest.spyOn(core, 'debug').mockImplementation(() => {})
+    jest.spyOn(core, 'info').mockImplementation(() => {})
+    jest.spyOn(core, 'warning').mockImplementation(() => {})
+  })
+
+  it('Check Artifact Name for any invalid characters', () => {
+    const invalidNames = [
+      'my\\artifact',
+      'my/artifact',
+      'my"artifact',
+      'my:artifact',
+      'my<artifact',
+      'my>artifact',
+      'my|artifact',
+      'my*artifact',
+      'my?artifact',
+      'my artifact',
+      ''
+    ]
+    for (const invalidName of invalidNames) {
+      expect(() => {
+        utils.checkArtifactName(invalidName)
+      }).toThrow()
+    }
+
+    const validNames = [
+      'my-normal-artifact',
+      'myNormalArtifact',
+      'm¥ñðrmålÄr†ï£å¢†'
+    ]
+    for (const validName of validNames) {
+      expect(() => {
+        utils.checkArtifactName(validName)
+      }).not.toThrow()
+    }
+  })
+
+  it('Test constructing artifact URL', () => {
+    const runtimeUrl = getRuntimeUrl()
+    const runId = getWorkFlowRunId()
+    const artifactUrl = utils.getArtifactUrl()
+    expect(artifactUrl).toEqual(
+      `${runtimeUrl}_apis/pipelines/workflows/${runId}/artifacts?api-version=${utils.getApiVersion()}`
+    )
+  })
+
+  it('Test constructing headers with all optional parameters', () => {
+    const type = 'application/json'
+    const size = 24
+    const range = 'bytes 0-199/200'
+    const options = utils.getRequestOptions(type, size, range)
+    expect(Object.keys(options).length).toEqual(4)
+    expect(options['Accept']).toEqual(
+      `${type};api-version=${utils.getApiVersion()}`
+    )
+    expect(options['Content-Type']).toEqual(type)
+    expect(options['Content-Length']).toEqual(size)
+    expect(options['Content-Range']).toEqual(range)
+  })
+
+  it('Test constructing headers with only required parameter', () => {
+    const options = utils.getRequestOptions()
+    expect(Object.keys(options).length).toEqual(1)
+    expect(options['Accept']).toEqual(
+      `application/json;api-version=${utils.getApiVersion()}`
+    )
+  })
+
+  it('Test Success Status Code', () => {
+    expect(utils.isSuccessStatusCode(HttpCodes.OK)).toEqual(true)
+    expect(utils.isSuccessStatusCode(201)).toEqual(true)
+    expect(utils.isSuccessStatusCode(299)).toEqual(true)
+    expect(utils.isSuccessStatusCode(HttpCodes.NotFound)).toEqual(false)
+    expect(utils.isSuccessStatusCode(HttpCodes.BadGateway)).toEqual(false)
+    expect(utils.isSuccessStatusCode(HttpCodes.Forbidden)).toEqual(false)
+  })
+
+  it('Test Retry Status Code', () => {
+    expect(utils.isRetryableStatusCode(HttpCodes.BadGateway)).toEqual(true)
+    expect(utils.isRetryableStatusCode(HttpCodes.ServiceUnavailable)).toEqual(
+      true
+    )
+    expect(utils.isRetryableStatusCode(HttpCodes.GatewayTimeout)).toEqual(true)
+    expect(utils.isRetryableStatusCode(HttpCodes.OK)).toEqual(false)
+    expect(utils.isRetryableStatusCode(HttpCodes.NotFound)).toEqual(false)
+    expect(utils.isRetryableStatusCode(HttpCodes.Forbidden)).toEqual(false)
+  })
+})