Screwdriver

An open source build platform designed for continuous delivery.
Alternatives To Screwdriver
Project NameStarsDownloadsRepos Using ThisPackages Using ThisMost Recent CommitTotal ReleasesLatest ReleaseOpen IssuesLicenseLanguage
Localstack51,415101612 hours ago402November 29, 2023349otherPython
💻 A fully functional local AWS cloud stack. Develop and test your cloud & Serverless apps offline
Javascript Testing Best Practices22,956
2 months ago63mitJavaScript
📗🌐 🚢 Comprehensive and exhaustive JavaScript & Node.js testing best practices (July 2023)
Ava20,58144,27933,63216 hours ago112December 06, 202354mitJavaScript
Node.js test runner that lets you develop with confidence 🚀
Volkswagen12,785562 months ago15October 16, 201561mitJavaScript
:see_no_evil: Volkswagen detects when your tests are being run in a CI server, and makes them pass.
Origin8,41815219a day ago76May 31, 2021185apache-2.0Go
Conformance test suite for OpenShift
Dockertest3,8632321,0979 days ago88April 06, 202330apache-2.0Go
Write better integration tests! Dockertest helps you boot up ephermal docker images for your Go tests with minimal work.
Test Infra3,76684a day ago1,009April 25, 2021250apache-2.0Go
Test infrastructure for the Kubernetes project.
Tox3,45518,2004,3013 days ago209November 28, 202393mitPython
Command line driven CI frontend and development task automation tool.
Garden3,19582 days ago1September 04, 2023201mpl-2.0TypeScript
Automation for Kubernetes development and testing. Spin up production-like environments for development, testing, and CI on demand. Use the same configuration and workflows at every step of the process. Speed up your builds and test runs via shared result caching
Testem2,93410,1571,0043 days ago389November 20, 2023133mitJavaScript
Test'em 'Scripts! A test runner that makes Javascript unit testing fun.
Alternatives To Screwdriver
Select To Compare


Alternative Project Comparisons
Readme

Screwdriver API

Version Pulls Stars Build Status Open Issues Coverage Vulnerabilities License Slack CII Best Practices

API for the Screwdriver CD service

Screwdriver is a self-contained, pluggable service to help you build, test, and continuously deliver software using the latest containerization technologies.

Table of Contents

Background

Screwdriver began as a hack for simplified interfacing with Jenkins at Yahoo in 2012. As the volume of builds increased, it became clear that Jenkins was not stable or feasible to use at the scale we were running builds. In 2016, we rebuilt Screwdriver from scratch in open source with our best coding practices and CICD goals in mind. Screwdriver is executor and SCM-agnostic, meaning you can choose whichever plugin better suits your need or build your own. It's completely free and open source, and our team is actively maintaining the code.

For more information about Screwdriver, check out our homepage.

Installation and Usage

Plugins

This API comes preloaded with 16 (sixteen) resources:

Three (3) option for datastores:

  • Postgres, MySQL, and Sqlite (sequelize)

Three (3) options for executor:

  • Kubernetes (k8s)
  • Docker (docker)
  • Nomad (nomad)

Three (3) options for SCM:

  • GitHub (github)
  • GitLab (gitlab)
  • Bitbucket (bitbucket)

Prerequisites

To use Screwdriver, you will need the following prerequisites:

From Source

$ git clone [email protected]:screwdriver-cd/screwdriver.git ./
$ npm install
$ vim ./config/local.yaml # See below for configuration
$ npm start
info: Server running at http://localhost:8080

From a Prebuilt Docker image

$ vim ./local.yaml # See below for configuration
$ docker run --rm -it --volume=`pwd`/local.yaml:/config/local.yaml -p 8080 screwdrivercd/screwdriver:stable
info: Server running at http://localhost:8080

Using In-A-Box

Our in-a-box script brings up an entire Screwdriver instance (ui, api, and log store) locally for you to play with. Follow instructions at screwdriver-cd/in-a-box.

Using Helm

This chart bootstraps the whole Screwdriver ecosystem and also nginx ingress controller.

Configuration

Screwdriver already defaults most configuration, but you can override defaults using a local.yaml or environment variables.

To continue set up, follow the instructions for cluster management.

Yaml

Example overriding local.yaml:

executor:
    plugin: k8s
    k8s:
        options:
            kubernetes:
                host: kubernetes.default
                token: this-is-a-real-token
            launchVersion: stable

scms:
    github:
        plugin: github
        config:
            oauthClientId: totally-real-client-id
            oauthClientSecret: another-real-client-secret
            secret: a-really-real-secret
            username: sd-buildbot
            email: [email protected]

Environment

Example overriding with environment variables:

$ export K8S_HOST=127.0.0.1
$ export K8S_TOKEN=this-is-a-real-token
$ export SECRET_OAUTH_CLIENT_ID=totally-real-client-id
$ export SECRET_OAUTH_CLIENT_SECRET=another-real-client-secret

All the possible environment variables are defined here.

Testing

Unit Tests

npm test

Note: You might run into memory issues running all the unit tests. You can update your ~/.bashrc file with the line below to ensure there's enough memory for tests to run:

export NODE_OPTIONS=--max_old_space_size=4096

Functional tests

Fork functional-* repositories to your organization from screwdriver-cd-test

With .func_config

Add .func_config to the root of the Screwdriver API folder with your username, github token, access key, host, and organization for test:

GIT_TOKEN=YOUR-GITHUB-TOKEN
SD_API_TOKEN=YOUR-SD-API-TOKEN
SD_API_HOST=YOUR-SD-API-HOST
SD_API_PROTOCOL=PROTOCOL-FOR-SD-API // e.g.PROTOCOL=http; by default it is https
TEST_ORG=YOUR-TEST-ORGANIZATION
TEST_USERNAME=YOUR-GITHUB-USERNAME
TEST_SCM_HOSTNAME=YOUR-TEST-SCM-HOSTNAME // e.g. TEST_SCM_HOSTNAME=mygithub.com; by default it is github.com
TEST_SCM_CONTEXT=YOUR-TEST-SCM-CONTEXT // e.g.TEST_SCM_CONTEXT=bitbucket; by default it is github

With environment variables

Set the environment variables:

$ export GIT_TOKEN=YOUR-GITHUB-TOKEN
$ export SD_API_TOKEN=YOUR-SD-API-TOKEN
$ export SD_API_HOST=YOUR-SD-API-HOST
$ export SD_API_PROTOCOL=PROTOCOL-FOR-SD-API
$ export TEST_ORG=YOUR-TEST-ORGANIZATION
$ export TEST_USERNAME=YOUR-GITHUB-USERNAME
$ export TEST_SCM_HOSTNAME=YOUR-TEST-SCM-HOSTNAME
$ export TEST_SCM_CONTEXT=YOUR-TEST-SCM-CONTEXT

Then run the cucumber tests:

npm run functional

Contribute

To start contributing to Screwdriver, have a look at our guidelines, as well as pointers on where to start making changes, in our contributing guide.

License

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

Popular Continuous Integration Projects
Popular Testing Projects
Popular Software Development Categories
Related Searches

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.
Javascript
Testing
Kubernetes
Continuous Integration
Jenkins
Environment Variables
Ci Cd
Continuous Delivery