From: Mathieu Lirzin <mthl@gnu.org>
To: guix-devel@gnu.org
Subject: [GSoC] Development of Cuirass.
Date: Sun, 12 Mar 2017 15:49:47 +0100 [thread overview]
Message-ID: <87tw6yim7o.fsf@gnu.org> (raw)
Hi,
Here is my proposal for the Google Summer of Code 2017.
1 Introduction
══════════════
[Cuirass] is a build automation server using GNU Guix package manager.
This project has started last year as a Google Summer of Code (GSoC)
with the goal of replacing [Hydra] which is the continous build server
used by Nix and Guix to provide package substitutes. Cuirass intends
to be a multi-purpose build automation server. It aims at allowing
users to have their own build farm for packages they maintain outside
of Guix tree, and at providing a tool for applying the principle of
continuous integration[1] in software development. To achieve this
goal a lot of things remain to be done.
[Cuirass] https://notabug.org/mthl/cuirass
[Hydra] https://nixos.org/hydra/
2 Proposal
══════════
The project is the continuation of last year work, and is separated in
two parts. The first part is to improve the testing infrastructure.
The second one is about providing a more complete HTTP API.
2.1 The testing infrastructure
──────────────────────────────
Currently Cuirass is providing a small test suite consisting only of
unit tests. The integration tests are done manually with basic
examples consisting in building small packages such as GNU Hello.
This is not good, because actual packages take a consequent time to
compile, and testing only basic examples leaves the interesting
complex case out of the scope of testing. The worst is that the
result depend on the phase of the moon since every commit in Guix can
potentially break the build.
The idea is to take inspiration from the Guix test suite by providing
tiny mocked packages that will help having lightweight build
specifications. Those tests require launching another instance of the
`guix-daemon' with a local temporary store.
2.2 HTTP API
────────────
Since commit [12d71ee098c3eb84a9a5dc2419bd37a3b9e55dd2] Cuirass has a
web server which is running in a separate thread of the `cuirass'
process. However the resources it provides are pretty limited since
you can only query the lists of specifications currently watched.
This is done with the `/specifications' or `/jobsets' resource names.
"Jobsets" is the terminology used by Hydra and is used here for
compatibility with its HTTP API.
The principal objective of this part is to provide a more complete API
which allows users to query the build results and to add their
specifications to the current set. The design of this API will apply
the principles of the Representational State Transfert (REST)
architectural pattern[2]. Sensitive requests should be done with an
authentification mechanism which is not determined yet. I currently
have no experience with any and lack the knowledge to properly choose
one.
[12d71ee098c3eb84a9a5dc2419bd37a3b9e55dd2]
https://notabug.org/mthl/cuirass/commit/12d71ee098c3eb84a9a5dc2419bd37a3b9e55dd2
3 Roadmap
═════════
This roadmap lacks details about the concrete tasks and its associated
timeline. However I prefer having some feedback about this proposal
first, before providing a complete roadmap.
• From May 30 to June 26, I will work on the testing infrastructure,.
• From June 27 to August 29, I will work on the HTTP API.
4 Feedback
══════════
Some people have expressed their interest in having a Web /frontend/
for Cuirass. To avoid possible confusions I have no plan in working
on it this summer. While this would be a very valuable effort, I
don't feel up to the task.
Regarding the Authentification mechanism, any enlighten advice or
resource would be welcome. If anybody think of other important tasks
that need to be addressed, please share.
Footnotes
─────────
[1] [https://martinfowler.com/articles/continuousIntegration.html]
[2] [https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm]
--
Mathieu Lirzin
GPG: F2A3 8D7E EB2B 6640 5761 070D 0ADE E100 9460 4D37
next reply other threads:[~2017-03-12 14:49 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-03-12 14:49 Mathieu Lirzin [this message]
2017-03-12 15:18 ` [GSoC] Development of Cuirass pelzflorian (Florian Pelz)
2017-03-12 18:41 ` Mathieu Lirzin
2017-03-12 23:45 ` pelzflorian (Florian Pelz)
2017-03-20 22:05 ` Mathieu Lirzin
2017-03-13 8:49 ` Ludovic Courtès
2017-03-20 22:43 ` Mathieu Lirzin
2017-03-13 10:32 ` Andy Wingo
2017-03-20 22:47 ` Mathieu Lirzin
2017-03-13 19:17 ` Efraim Flashner
2017-03-21 14:31 ` Mathieu Lirzin
2017-03-21 14:40 ` Ludovic Courtès
2017-03-21 16:54 ` Jan Nieuwenhuizen
2017-03-21 17:25 ` Tobias Geerinckx-Rice
2017-03-21 18:55 ` Leo Famulari
2017-03-22 16:11 ` Ricardo Wurmus
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87tw6yim7o.fsf@gnu.org \
--to=mthl@gnu.org \
--cc=guix-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).