Documentation

Global

Methods

connect(browser, done)

Connect to the SSE Gateway.

DO NOT CALL: done automatically in the globals.

Parameters:
Name Type Description
browser
done

createBranch(branchName, pathToRepo)

Create a new branch in a given repository

Parameters:
Name Type Description
branchName String

name of the branch
pathToRepo String

the route to the repository
Returns:
Type
*

createCommit(pathToRepo, files)

Create and return a commit promise.

Parameters:
Name Type Description
pathToRepo String

the route to the repository
files Array

to be committed

createFile(pathToRepo, fileName, options)

Creates a file and adds it to repo.

FIXME: doesnt seem to actally git add the file, altohugh it does create the commit hash.

Parameters:
Name Type Description
pathToRepo String

the route to the repository
fileName String

name of the file
options Object
Properties
Name Type Description
contents string

optional contents to write to file.
message string

optional commit message.
Returns:
Type
*

createRepo(fromDir, inDir)

create a new git repository

Parameters:
Name Type Description
fromDir String

source path
inDir String

destination path

disable(category)

disable debug for a specific category

Parameters:
Name Type Description
category

disconnect( [onDisconnected])

Disconnect from the SSE Gateway.

DO NOT CALL: done automatically in the globals.

Parameters:
Name Type Argument Description
onDisconnected function <optional>

callback to be invoke when finished, will pass the sse event to the callback

enable(category)

enable debug for a specific category

Parameters:
Name Type Description
category

init(pathToRepo, onInit)

Generic wrapper aroung NodeGit

Parameters:
Name Type Description
pathToRepo String
onInit function

setDEBUG()

Turn on debug

urlEndsWith(expected [, message])

Checks if the current url ends with the given value.

   this.demoTest = function (client) {
     browser.assert.urlEndsWith('/blue/organizations/jenkins/my-pipeline/activity');
   };
Parameters:
Name Type Argument Description
expected string

The expected url.
message string <optional>

Optional log message to display in the output. If missing, one is displayed by default.