Screwdriver Models

Screwdriver models

Usage

Asynchronous methods return promises.

npm install screwdriver-models

Pipeline Factory

Search

'use strict';
const Model = require('screwdriver-models');
const factory = Model.PipelineFactory.getInstance({
    datastore,
    scm
});
const config = {
    params: {
        scmUri: 'github.com:12345:banana'
    },
    paginate {
        page: 2,
        count: 3
    }
}

factory.list(config).then(pipelines => {
    // Do stuff with list of pipelines
});

Parameter	Type	Description
config	Object	Config Object
config.paginate.page	Number	The page for pagination
config.paginate.count	Number	The count for pagination
config.params	Object	fields to search on

Create

factory.create(config).then(model => {
    // do stuff with pipeline model
});

Parameter	Type	Required	Description
config	Object	Yes	Configuration Object
config.admins	Object	Yes	Admins for this pipeline, e.g { batman: true }
config.scmUri	String	Yes	Source Code URI for the application

Get

Get a pipeline based on id. Can pass the generatedId for the pipeline, or the unique keys for the model, and the id will be determined automatically.

factory.get(id).then(model => {
    // do stuff with pipeline model
});

factory.get({ scmUri }).then(model => {
    // do stuff with pipeline model
});

Parameter	Type	Description
id	String	The unique ID for the pipeline
config.scmUri	String	Source Code URI for the application

Pipeline Model

Update

Update a specific pipeline model

model.update()

Example:

'use strict';
const Model = require('screwdriver-models');
const factory = Model.PipelineFactory.getInstance({
    datastore,
    scm
});
const scmUri = 'github.com:12345:master';
factory.get({ scmUri }).then(model => {
    model.scmUri = 'github.com:12345:foo';
    return model.update();
})

Add Screwdriver webhook

Attach Screwdriver webhook to the pipeline's repository

model.addWebhook(webhookUrl)

Parameter	Type	Description
webhookUrl	String	The webhook url to be added

Sync

Sync the pipeline. Look up the configuration in the repo to create and delete jobs if necessary.

model.sync()

Get Configuration

Get the screwdriver configuration for the pipeline at the given ref

model.getConfiguration(config)

Parameter	Type	Required	Description
ref	String	No	Reference to the branch or PR

Get Jobs

Return a list of jobs that belong to this pipeline

model.getJobs(config)

Parameter	Type	Required	Default	Description
config	Object	No		Configuration Object
config.params	Object	No		Fields to search on
config.params.sort	Boolean	No	false	Sorting by createTime

Get Events

Return a list of events that belong to this pipeline

model.getEvents(config)

Parameter	Type	Required	Default	Description
config	Object	No		Config Object
config.type	Number	No	`pipeline`	Type of event: `pipeline` or `pr`
config.sort	Number	No	`descending`	Sorting by createTime

Job Factory

Search

'use strict';
const Model = require('screwdriver-models');
const factory = Model.JobFactory.getInstance({
    datastore
});
const config = {
    params: {
        pipelineId: 'aabbccdd1234'
    },
    paginate {
        page: 2,
        count: 3
    }
}

factory.list(config).then(jobs => {
    // Do stuff with list of jobs
});

Parameter	Type	Description
config	Object	Configuration Object
config.paginate.page	Number	The page for pagination
config.paginate.count	Number	The count for pagination
config.params	Object	fields to search on

Create

factory.create(config).then(model => {
    // do stuff with job model
});

Parameter	Type	Description
config	Object	Configuration Object
config.pipelineId	String	The pipelineId that the job belongs to
config.name	String	The name of the job

Get

Get a job based on id. Can pass the generatedId for the job, or the unique keys for the model, and the id will be determined automatically.

factory.get(id).then(model => {
    // do stuff with job model
});

factory.get({ pipelineId, name }).then(model => {
    // do stuff with job model
});

Parameter	Type	Description
id	String	The unique ID for the job
config.pipelineId	String	Id of the pipeline the job is associated with
config.name	String Name of the job

Job Model

'use strict';
const Model = require('screwdriver-models');
const factory = Model.JobFactory.getInstance({
    datastore
});

factory.get(id).then(model => {
    model.name = 'hello';
    return model.update();
});

Update

Update a job

model.update()

Get builds

Return builds that belong to this job

mode..getBuilds(config)

Parameter	Type	Required	Default	Description
config	Object	No		Configuration Object
config.sort	String	No	descending	`ascending` or `descending`

Get running builds

Return all running builds that belong to this jobId

model.getRunningBuilds()

Build Factory

Search

'use strict';
const Model = require('screwdriver-models');
const factory = Model.BuildFactory.getInstance({  
    datastore,
    scm,
    executor,
    uiUri
});
const config = {
    params: {
        jobId: 'aaabbccdd1234'
    },
    paginate {
        page: 2,
        count: 3
    }
}

factory.list(config).then(builds => {
    // Do stuff with list of builds
});

Parameter	Type	Description
config	Object	Config Object
config.paginate.page	Number	The page for pagination
config.paginate.count	Number	The count for pagination
config.params	Object	fields to search on

Create

factory.create(config).then(model => {
    // do stuff with build model
});

Parameter	Type	Required	Description
config	Object	Yes	Configuration Object
config.apiUri	String	Yes	URI back to the API
config.tokenGen	Function	Yes	Generator for building tokens
config.username	String	Yes	User who made the change to kick off the build
config.container	String	No	Container for the build to run in
config.sha	String	No	SHA used to kick off the build
config.prRef	String	No	PR branch or reference; required for PR jobs
config.eventId	String	No	Id of the event this build belongs to

Get

Get a build based on id. Can pass the generatedId for the build, or the unique keys for the model, and the id will be determined automatically.

factory.get(id).then(model => {
    // do stuff with build model
});

factory.get({ jobId, number }).then(model => {
    // do stuff with build model
});

Parameter	Type	Description
id	String	The unique ID for the build
config.jobId	String	The unique ID for a job
config.number	Number	build number

Build Model

'use strict';
const Model = require('screwdriver-models');
const factory = Model.BuildFactory.getInstance({  
    datastore,
    scm,
    executor,
    uiUri
});

factory.get(id).then(model => {
    model.state = 'FAILURE';
    model.update();
});

Update

Update a specific build

model.update()

Stream

Stream the log of a build

model.stream()

Update commit status

Update a commit status

model.updateCommitStatus(pipeline)

Parameter	Type	Description
pipeline	Pipeline	The pipeline that this build belongs to

Start a build

Start the build and update commit status as pending

model.start()

Stop a build

model.stop()

Check if a build is done

model.isDone()

User Factory

Search

'use strict';
const Model = require('screwdriver-models');
const factory = Model.UserFactory.getInstance({
    datastore,
    scm,
    password            // Password to seal/unseal user's token
});
const config = {
    params: {
        username: 'batman'
    },
    paginate {
        page: 2,
        count: 3
    }
}

factory.list(config).then(users => {
    // Do stuff with list of users
});

Parameter	Type	Description
config	Object	Config Object
config.paginate.page	Number	The page for pagination
config.paginate.count	Number	The count for pagination
config.params	Object	fields to search on

Create

factory.create(config).then(model => {
    // do stuff with user model
});

Parameter	Type	Required	Description
config	Object	Yes	Configuration Object
config.username	String	Yes	User who made the change to kick off the build
config.token	String	Yes	unsealed token
config.password	String	Yes	User's password used to seal/unseal token, not saved in datastore

Get

Get a user based on id. Can pass the generatedId for the user, or the username, and the id will be determined automatically. Can also pass a Screwdriver access token, and will get the user associated with that token.

factory.get(id).then(model => {
    // do stuff with user model
});

factory.get({ username }).then(model => {
    // do stuff with user model
});

factory.get({ token }).then(model => {
    // do stuff with user model
});

Parameter	Type	Description
id	String	The unique ID for the build
config.username	String	User name
config.accessToken	String	A user access token value

User Model

'use strict';
const Model = require('screwdriver-models');
const factory = Model.UserFactory.getInstance({
    datastore,
    scm,
    password                    // Password to seal/unseal user's token
});
const config = {
    username: 'myself',
    token: 'eyJksd3',            // User's github token
    password
}

factory.create(config)
    .then(user => user.getPermissions(scmUri))
    .then(permissions => {
        // do stuff here
    });

Update

Update a specific user

model.update()

Seal Token

Seal a token

model.sealToken(token)

Parameter	Type	Description
token	String	The token to seal

Unseal Token

Unseal the user's token

model.unsealToken()

Get User's Permissions For a Repo

Get user's permissions for a specific repo

model.getPermissions(scmUri)

Parameter	Type	Description
scmUri	String	The scmUri of the repo

Tokens

Get the user's access tokens

model.tokens
    .then((tokens) => {
        // do stuff with tokens
    });

Secret Factory

Search

'use strict';
const Model = require('screwdriver-models');
const factory = Model.SecretFactory.getInstance({
    datastore,
    password            // Password for encryption operations
});
const config = {
    params: {
        pipelineId: '2d991790bab1ac8576097ca87f170df73410b55c'
    },
    paginate {
        page: 2,
        count: 3
    }
}

factory.list(config).then(secrets => {
    // Do stuff with list of secrets
});

Parameter	Type	Description
config	Object	Config Object
config.paginate.page	Number	The page for pagination
config.paginate.count	Number	The count for pagination
config.params	Object	fields to search on

Create

factory.create(config).then(model => {
    // do stuff with secret model
});

Parameter	Type	Required	Description
config	Object	Yes	Configuration Object
config.pipelineId	String	Yes	Pipeline that this secret belongs to
config.name	String	Yes	Secret name
config.value	String	Yes	Secret value
config.allowInPR	String	Yes	Flag to denote if this secret can be shown in PR builds

Get

Get a secret based on id. Can pass the generatedId for the secret, or the combination of pipelineId and secret name, and the id will be determined automatically.

factory.get(id).then(model => {
    // do stuff with secret model
});

factory.get({ pipelineId, name }).then(model => {
    // do stuff with secret model
});

Parameter	Type	Description
id	String	The unique ID for the build
config.pipelineId	String	Pipeline that the secret belongs to
config.name	String	Secret name

Secret Model

'use strict';
const Model = require('screwdriver-models');
const factory = Model.SecretFactory.getInstance({
    datastore,
    password            // Password for encryption operations
});
const config = {
    pipelineId: '2d991790bab1ac8576097ca87f170df73410b55c',
    name: 'NPM_TOKEN',
    value: banana,
    allowInPR: false
}

factory.create(config)
    .then(model => // do something
    });

Update

Update a specific secret

model.update()

Event Factory

Search

'use strict';
const Model = require('screwdriver-models');
const factory = Model.EventFactory.getInstance({
    datastore,
    scm
});
const config = {
    params: {
        pipelineId: '2d991790bab1ac8576097ca87f170df73410b55c'
    }
}

factory.list(config).then(events => {
    // Do stuff with list of events
});

Parameter	Type	Description
config	Object	Config Object
config.params	Object	fields to search on

Create

factory.create(config).then(model => {
    // do stuff with event model
});

Parameter	Type	Required	Description
config	Object	Yes	Configuration Object
config.type	String	No	Event type: pipeline or pr
config.pipelineId	String	Yes	Unique identifier of pipeline
config.sha	String	Yes	Commit sha that the event was based on
config.workflow	Array	Yes	Workflow of the pipeline
config.username	String	Yes	Username of the user that creates this event
config.causeMessage	String	No	Message that describes why the event was created

Get

Get an event based on id. Can pass the generatedId for the event, or { pipelineId, sha } and the id will be determined automatically.

factory.get(id).then(model => {
    // do stuff with event model
});

factory.get({ pipelineId, sha }).then(model => {
    // do stuff with event model
});

Parameter	Type	Description
id	String	The unique ID for the build
config.pipelineId	String	Unique identifier of pipeline
config.sha	String	Commit sha that the event was based on

Event Model

'use strict';
const Model = require('screwdriver-models');
const factory = Model.EventFactory.getInstance({
    datastore,
    scm
});
const config = {
    pipelineId: '12345f642bbfd1886623964b4cff12db59869e5d',
    sha: 'ccc49349d3cffbd12ea9e3d41521480b4aa5de5f',
    workflow: ['main', 'publish'],    
    username: 'stjohn',
    causeMessage: 'Merge pull request #26 from screwdriver-cd/models'
}

factory.create(config)
    .then(model => {    // do something
    });

Example event model that got created:

{
    "type": "pipeline",
    "pipelineId": "12345f642bbfd1886623964b4cff12db59869e5d",
    "sha": "ccc49349d3cffbd12ea9e3d41521480b4aa5de5f",
    "createTime": "2038-01-19T03:14:08.131Z",
    "commit": {
        "url": "https://link.to/commitDiff",
        "message": "some commit message that is here",
        "author": {
            "avatar": "https://avatars.githubusercontent.com/u/1234567?v=3",
            "name": "Batman",
            "url": "https://internal-ghe.mycompany.com/imbatman",
            "username": "imbatman"
        }
    },
    "workflow": ["main", "publish"],
    "causeMessage": "Merge pull request #26 from screwdriver-cd/models",
    "creator": {
        "avatar": "https://avatars.githubusercontent.com/u/2042?v=3",
        "name": "St John",
        "url": "https://github.com/stjohn",
        "username": "stjohn"
    }
}

Update

Update a specific event

model.update()

Get builds

Get builds that belong to this event

model.getBuilds()

Template Model

'use strict';
const Model = require('screwdriver-models');
const factory = Model.TemplateFactory.getInstance({
    datastore
});
const config = {
    name: 'testTemplate',
    version: '1.3',
    description: 'I am a test template',    
    maintainer: 'foo@bar.com',
    scmUri: 'github:123:master',
    config: { image: 'node:6'},
    labels: ['beta', 'stable']
}

factory.create(config)
    .then(model => {    // do something
    });

Update

Update a specific template

model.update()

Template Factory

Create

factory.create(config).then(model => {
    // do stuff with template model
});

Parameter	Type	Required	Description
config	Object	Yes	Configuration Object
config.name	String	Yes	The template name
config.version	String	Yes	Version of the template
config.description	String	Yes	Description of the template
config.maintainer	Array	Yes	Maintainer's email
config.config	Object	Yes	Config of the screwdriver-template.yaml
config.pipelineId	String	Yes	pipelineId of the template
config.labels	Array	No	Labels attached to the template

Get

Get a template based on id.

factory.get(id).then(model => {
    // do stuff with template model
});

Parameter	Type	Description
id	String	The unique ID for the Template

Get Template

Get the latest template by name, version with/without label. The version can be in any valid version format. It can can be only major, or major.minor, or major.minor.patch. If label is specified, then the latest version with that label will be resolved. If no match found, the function will resolve undefined.

factory.get(config).then(model => {
    // do stuff with template model
});

Parameter	Type	Required	Description
config	Object	Yes	Configuration Object
config.name	String	Yes	The template name
config.version	String	Yes	Version of the template
config.label	String	No	Label of the template

Token Factory

Search

'use strict';
const Model = require('screwdriver-models');
const factory = Model.TokenFactory.getInstance({
    datastore
});
const config = {
    params: {
        userId: 12345
    },
    paginate {
        page: 1,
        count: 3
    }
}

factory.list(config).then(tokens => {
    // Do stuff with list of tokens
});

Parameter	Type	Description
config	Object	Config Object
config.paginate.page	Number	The page for pagination
config.paginate.count	Number	The count for pagination
config.params	Object	fields to search on

Create

factory.create(config).then(model => {
    // do stuff with token model
});

Parameter	Type	Required	Description
config	Object	Yes	Configuration Object
config.userId	Number	Yes	User that this token belongs to
config.name	String	Yes	Token name
config.description	String	No	Description of the token

Get

Get a token based on id. Can pass the generatedId for the token, or the token value, and the id will be determined automatically.

factory.get(id).then(model => {
    // do stuff with token model
});

factory.get({ value }).then(model => {
    // do stuff with token model
});

Parameter	Type	Description
id	Number	The unique ID for the token
config.value	String	The value of the token

Token Model

'use strict';
const Model = require('screwdriver-models');
const factory = Model.TokenFactory.getInstance({
    datastore,
});
const config = {
    userId: 12345,
    name: 'NPM_TOKEN',
    description: 'A token for use by npm'
}

factory.create(config)
    .then(model => // do something
    });

Update

Update a specific token

model.update()

Refresh

Refresh a token's value while preserving its other metadata. Attaches a temporary "value" field to the model

token.refresh()
    .then(model => // do something with the new model.value
    });

Testing

npm test

License

Code licensed under the BSD 3-Clause license. See LICENSE file for terms.

Name		Name	Last commit message	Last commit date
Latest commit History 288 Commits
lib		lib
test		test
.editorconfig		.editorconfig
.eslintignore		.eslintignore
.eslintrc.yaml		.eslintrc.yaml
.gitignore		.gitignore
.npmignore		.npmignore
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
index.js		index.js
package.json		package.json
screwdriver.yaml		screwdriver.yaml

License

yokawara/models

Folders and files

Latest commit

History

Repository files navigation

Screwdriver Models

Usage

Pipeline Factory

Search

Create

Get

Pipeline Model

Update

Add Screwdriver webhook

Sync

Get Configuration

Get Jobs

Get Events

Job Factory

Search

Create

Get

Job Model

Update

Get builds

Get running builds

Build Factory

Search

Create

Get

Build Model

Update

Stream

Update commit status

Start a build

Stop a build

Check if a build is done

User Factory

Search

Create

Get

User Model

Update

Seal Token

Unseal Token

Get User's Permissions For a Repo

Tokens

Secret Factory

Search

Create

Get

Secret Model

Update

Event Factory

Search

Create

Get

Event Model

Update

Get builds

Template Model

Update

Template Factory

Create

Get

Get Template

Token Factory

Search

Create

Get

Token Model

Update

Refresh

Testing

License

About

Resources

License

Stars

Packages