Skip to content

Commit

Permalink
Add additional tests
Browse files Browse the repository at this point in the history
  • Loading branch information
luketomlinson committed Jul 2, 2021
1 parent fe09733 commit b3d7aa3
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 11 deletions.
41 changes: 34 additions & 7 deletions packages/core/__tests__/core.test.ts
Expand Up @@ -2,6 +2,7 @@ import * as fs from 'fs'
import * as os from 'os'
import * as path from 'path'
import * as core from '../src/core'
import { toCommandProperties } from '../src/utils'

/* eslint-disable @typescript-eslint/unbound-method */

Expand Down Expand Up @@ -141,17 +142,17 @@ describe('@actions/core', () => {
})

it('getInput gets required input', () => {
expect(core.getInput('my input', {required: true})).toBe('val')
expect(core.getInput('my input', { required: true })).toBe('val')
})

it('getInput throws on missing required input', () => {
expect(() => core.getInput('missing', {required: true})).toThrow(
expect(() => core.getInput('missing', { required: true })).toThrow(
'Input required and not supplied: missing'
)
})

it('getInput does not throw on missing non-required input', () => {
expect(core.getInput('missing', {required: false})).toBe('')
expect(core.getInput('missing', { required: false })).toBe('')
})

it('getInput is case insensitive', () => {
Expand Down Expand Up @@ -182,13 +183,13 @@ describe('@actions/core', () => {

it('getInput trims whitespace when option is explicitly true', () => {
expect(
core.getInput('with trailing whitespace', {trimWhitespace: true})
core.getInput('with trailing whitespace', { trimWhitespace: true })
).toBe('some val')
})

it('getInput does not trim whitespace when option is false', () => {
expect(
core.getInput('with trailing whitespace', {trimWhitespace: false})
core.getInput('with trailing whitespace', { trimWhitespace: false })
).toBe(' some val ')
})

Expand All @@ -197,7 +198,7 @@ describe('@actions/core', () => {
})

it('getInput gets required input', () => {
expect(core.getBooleanInput('boolean input', {required: true})).toBe(true)
expect(core.getBooleanInput('boolean input', { required: true })).toBe(true)
})

it('getBooleanInput handles boolean input', () => {
Expand All @@ -212,7 +213,7 @@ describe('@actions/core', () => {
it('getBooleanInput handles wrong boolean input', () => {
expect(() => core.getBooleanInput('wrong boolean input')).toThrow(
'Input does not meet YAML 1.2 "Core Schema" specification: wrong boolean input\n' +
`Support boolean input list: \`true | True | TRUE | false | False | FALSE\``
`Support boolean input list: \`true | True | TRUE | false | False | FALSE\``
)
})

Expand Down Expand Up @@ -269,6 +270,12 @@ describe('@actions/core', () => {
assertWriteCalls([`::error::Error: ${message}${os.EOL}`])
})

it('error handles parameters correctly', () => {
const message = 'this is my error message'
core.error(new Error(message), { title: 'A title', startColumn: 1, endColumn: 2, startLine: 5, endLine: 5 })
assertWriteCalls([`::error title=A title,line=5,end_line=5,col=1,end_column=2::Error: ${message}${os.EOL}`])
})

it('warning sets the correct message', () => {
core.warning('Warning')
assertWriteCalls([`::warning::Warning${os.EOL}`])
Expand All @@ -285,6 +292,26 @@ describe('@actions/core', () => {
assertWriteCalls([`::warning::Error: ${message}${os.EOL}`])
})

it('warning handles parameters correctly', () => {
const message = 'this is my error message'
core.warning(new Error(message), { title: 'A title', startColumn: 1, endColumn: 2, startLine: 5, endLine: 5 })
assertWriteCalls([`::warning title=A title,line=5,end_line=5,col=1,end_column=2::Error: ${message}${os.EOL}`])
})

it('annotations map field names correctly', () => {
const commandProperties = toCommandProperties({ title: 'A title', startColumn: 1, endColumn: 2, startLine: 5, endLine: 5 })
expect(commandProperties.title).toBe('A title')
expect(commandProperties.col).toBe(1)
expect(commandProperties.end_column).toBe(2)
expect(commandProperties.line).toBe(5)
expect(commandProperties.end_line).toBe(5)

expect(commandProperties.startColumn).toBeUndefined()
expect(commandProperties.endColumn).toBeUndefined()
expect(commandProperties.startLine).toBeUndefined()
expect(commandProperties.endLine).toBeUndefined()
})

it('startGroup starts a new group', () => {
core.startGroup('my-group')
assertWriteCalls([`::group::my-group${os.EOL}`])
Expand Down
8 changes: 4 additions & 4 deletions packages/core/src/core.ts
Expand Up @@ -44,23 +44,23 @@ export interface AnnotationProperties {
/**
* The start line for the annotation.
*/
startLine?: string
startLine?: number

/**
* The end line for the annotation. Defaults to `startLine` when `startLine` is provided.
*/
endLine?: string
endLine?: number

/**
* The start column for the annotation. Cannot be sent when `startLine` and `endLine` are different values.
*/
startColumn?: string
startColumn?: number

/**
* The start column for the annotation. Cannot be sent when `startLine` and `endLine` are different values.
* Defaults to `startColumn` when `startColumn` is provided.
*/
endColumn?: string
endColumn?: number
}

//-----------------------------------------------------------------------
Expand Down

0 comments on commit b3d7aa3

Please sign in to comment.