Git mirror of the Assemblage continuous integration toolkit
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
certs
data/assemblage/migrations
lib
spec
.document
.editorconfig
.gems
.hgignore
.pryrc
.rdoc_options
.ruby-gemset
.ruby-version
.simplecov
Gemfile
Gemfile.devel
Gemfile.devel.lock
History.md
LICENSE.txt
Manifest.txt
Protocol.md
README.md
Rakefile
assemblage.gemspec

README.md

Assemblage

A continuous integration toolkit.

home : https://assembla.ge/

code : https://bitbucket.org/sascrotch/assemblage

github : https://github.com/ged/assemblage

docs : http://assembla.ge/docs/assemblage

Description

Assemblage is a continuous integration library. It's intended to provide you with a minimal toolkit for distributing and performing automated tasks for one or more version control repositories. It makes as few assumptions as possible as to what those tasks might be.

A task in Assemblage is called an Assembly. Assemblage has three primary parts for manipulating Assemblies: the Assembly Server, Assembly Workers, and Repositories.

Assembly Server
Aggregates and distributes events from repositories to workers via one or more "assemblies".
Assembly Workers
Listens for events published by the assembly server, checks out a repository, and runs an assembly script in that repository.
Repository
A distributed version control repository. Assemblage currently supports Mercurial and Git.

Prerequisites

  • Ruby
  • libzmq >= 4.2.3 (with drafts enabled)
  • czmq >= 4.1.0 (with drafts enabled)
  • A DVCS; Assemblage currently supports Mercurial and Git.

Installation

This example uses three different hosts for the three parts, but you can, of course, run all of this on a single host.

You'll first need a server to manage your assemblies:

example $ sudo gem install assemblage
example $ assemblage create server /usr/local/assemblage
Creating a server run directory in /usr/local/assemblage...
Generating a server key...
Creating the assemblies database...
done.

You can start the assembly server like so:
  assemblage -c /usr/local/assemblage/config.yml start server

Server public key is:
  &}T0.[{MZSJC]roN-{]x2QCkG+dXki!6j!.1JU1u

example $ assemblage -c /usr/local/assemblage/config.yml start server
Starting assembly server at:
  tcp://example.com:7872

Now (possibly on a different host) you can create a new worker installation. Workers have a name and a list of tags that describe its capabilities, e.g., the OS it's running on, installed software, etc. Our example is running on FreeBSD 11, and has Ruby 2.4, Ruby 2.5, Python 2.7, ZeroMQ, and the PostgreSQL client libraries available. We'll use a pretty simple tag convention but you can make it as simple or complex as you want.

user@example-client $ sudo gem install assemblage
user@example-client $ mkdir -p /usr/local/assemblage
user@example-client $ cd /usr/local/assemblage
user@example-client $ assemblage create worker \
  -t freebsd,freebsd11,ruby,ruby24,ruby25,python,python27,zeromq,libpq worker1
Creating a new assembly worker run directory in
  /usr/local/assemblage/worker1...
Set up with worker name: example-client-worker1
Client public key is:
  PJL=qK@SHy3#re-w@W)4C]Aj+aD}toGf*Y*SOOZ4
done.

Now we need to register the client with the server. On the server host:

user@example $ assemblage add worker example-client-worker1 \
  "PJL=qK@SHy3#re-w@W)4C]Aj+aD}toGf*Y*SOOZ4"
Approving connections from example-client-worker1...
done.

Now go back to the worker and tell it that it should talk to the new server we just set up:

user@example-client $ cd /usr/local/assemblage/worker1
user@example-client $ assemblage add server \
  tcp://example.com:7872 "&}T0.[{MZSJC]roN-{]x2QCkG+dXki!6j!.1JU1u"
Talking to tcp://example.com:7872...
Testing registration... success.
done.

Now you can start the worker, which will listen for jobs it can work on.

user@example-client $ cd /usr/local/assemblage/worker1
user@example-client $ assemblage start worker
Starting assembly worker `worker1`...
Connecting to assembly servers...
   example... done.
Waiting for jobs...

Now we need our repositories to notify the assembly server when events occur. We'll hook up a Mercurial repo for a Ruby library so that it runs unit tests whenever there's a new commit. First we'll install assemblage on the repo server and create a run directory for repo operations:

user@example-repo $ sudo gem install assemblage hglib
user@example-repo $ mkdir /usr/local/hg/repos/.assemblage
user@example-repo $ cd /usr/local/hg/repos/.assemblage
user@example-repo $ assemblage create repo project1
Creating a new assemblage repo run directory in
  /usr/local/hg/repos/.assemblage...
Set up with repo name: project1
Client public key is:
  bq9VheQbLtcu]LGK4I&xzK3^UW0Iyak/6<YS=^$w
done.

Now we'll need to register the repo on the server like we did before for the worker:

user@example $ assemblage add repo project1 http://repo.example.com/project1
Looking for repo registration... found.
Approving repo events from http://repo.example.com/project1...
done.

We'll add a hook to the repository's .hg/hgrc that looks like:

[hooks]
incoming.assemblage = /usr/local/bin/assemblage send-event commit \
  project1 $HG_NODE

And finally, we'll combine all the parts into an assembly called project1-freebsd-tests that will run on a worker with the freebsd, ruby, and libpq tags for each commit to the repo at http://repo.example.com/project1:

user@example $ assemblage add -t freebsd,ruby,libpq \
  http://repo.example.com/project1

Now when commits arrive at our repo, it will send events to the assembly server, which will queue up an assembly. Because the worker we added has all of the required tags, it will:

  • get a notification of the commit
  • clone the repository checked out to that commit
  • look for an assembly script called commit in a directory called .assemblies/ (by default)
  • if it finds one, it will run the script from the cloned repo
  • it will then send back any files contained in the .assemblies/ subdirectory with the SHA of the commit (if it exists) along with the exit code of the script.

Contributing

You can check out the current development source with Mercurial via Bitbucket. Or if you prefer Git, via its Github mirror.

After checking out the source, run:

$ rake newb

This task will install any missing dependencies, run the tests/specs, and generate the API documentation.

License

Copyright (c) 2018, Michael Granger All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the author/s, nor the names of the project's contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.