Skip to content

Testsuite
Testsuite
Commit 91edba69 authored by zauberstuhl's avatar zauberstuhl
Browse files
Options

Add separate documentation page

parent b5b05e79
Hide whitespace changes
Inline Side-by-side
Showing with 1924 additions and 135 deletions
.gitignore 0 → 100644
View file @ 91edba69
public
docs/_site
docs/.sass-cache
docs/.jekyll-metadata
docs/public
.gitlab-ci.yml
View file @ 91edba69
image: debian
stages:
- test
- deploy
.job_template: &job_definition
image: debian
stage: test
artifacts:
reports:
junit: report.xml
......@@ -9,6 +14,12 @@ image: debian
- bash scripts/install.sh
script:
- bash scripts/test.sh
.job_template: &no_pipeline
except:
variables:
- $CI_PIPELINE_TRIGGERED
single project:
<<: *job_definition
only:
......@@ -16,24 +27,37 @@ single project:
- master
variables:
- $CI_PIPELINE_TRIGGERED
test diaspora:
<<: *job_definition
<<: *no_pipeline
variables:
PROJECT: diaspora
except:
variables:
- $CI_PIPELINE_TRIGGERED
test ganggo:
<<: *job_definition
<<: *no_pipeline
variables:
PROJECT: ganggo
except:
variables:
- $CI_PIPELINE_TRIGGERED
test socialhome:
<<: *job_definition
<<: *no_pipeline
variables:
PROJECT: socialhome
except:
variables:
- $CI_PIPELINE_TRIGGERED
pages:
<<: *no_pipeline
image: ruby:2.3
stage: deploy
variables:
JEKYLL_ENV: production
LC_ALL: C.UTF-8
before_script:
- cd docs
- bundle install
script:
- bundle exec jekyll build -d ../public
artifacts:
paths:
- public
README.md
View file @ 91edba69
# Federation Tests
[![](https://testsuite.feneas.org/images/stats/builds.png)](https://testsuite.feneas.org)
This repository is about automating federation tests in the network itself!
* [the-federation.info](https://the-federation.info/)
* [testsuite.feneas.org](https://testsuite.feneas.org/)
## Projects
Following projects are using the testsuite:
* [GangGo](https://github.com/ganggo)
* [Socialhome](https://github.com/jaywink/socialhome)
## Add your project
Clone this repository and create a new directory:
git clone https://git.feneas.org/feneas/federation-testsuite.git
cd federation-testsuite && mkdir <project-name>
In this folder you have to put everything which is required for building an automated docker image.
Starting with a `Dockerfile` and a start-up script e.g. `start.sh`
The start-up script is required so that we can do some configuration magic at boot time.
Following environment variables will be available while tests are running:
$DATABASE (on every run)
$PORT (on every run)
$PRREPO (only on pull_requests from a user)
$PRSHA (only on pull_requests from a user)
$(hostname -i) (if you need the container IP address)
This information we can use in our start-up script mentioned above.
For example if `PRREPO` and `PRSHA` is set we probably want to checkout the source code of the pull request first.
See for reference the start-up script of the ganggo image:
```
#!/bin/bash
repo=$GOPATH/src/github.com/ganggo/ganggo
if [ ! -z ${PRSHA} ]; then
if [ "$(basename $PRREPO)" == "ganggo.git" ]; then
cd $repo && git stash \
&& git remote add custom $PRREPO \
&& git fetch custom \
&& git checkout $PRSHA \
&& git log -1 || {
echo "Cannot find $PRREPO $PRSHA"
exit 1
}
fi
if [ "$(basename $PRREPO)" == "federation.git" ]; then
wd=$repo/vendor/github.com/ganggo/federation
rm -r $wd && git clone $PRREPO $wd \
&& cd $wd \
&& git checkout $PRSHA \
&& git log -1 || {
echo "Cannot checkout $PRREPO $PRSHA"
exit 1
}
fi
fi
sed -i "s/NAME/$DATABASE/g" $repo/conf/app.conf \
&& sed -i "s/PORT/$PORT/g" $repo/conf/app.conf \
&& revel run github.com/ganggo/ganggo
```
In the above example support for `github.com/ganggo/federation` and `github.com/ganggo/ganggo` was added.
If a user triggers a build with the following parameters:
PRREPO=https://github.com/someuser/federation.git
PRSHA=1234567890
The testsuite will replace the offical with the user repository and checkout the mentioned commit.
If you did all that `\m/` Create a pull-request with your changes in this repository and as soon as we merged it.
You can add your repository [here](https://testsuite.feneas.org/)!
Now the testing can begin :)
# Development
## Dependencies
In case you want to test specific parts locally you need `docker`.
Make sure it is up and running:
sudo systemctl start docker.service
Then you can install the testsuite dependencies:
* github.com/stedolan/jq
* github.com/sstephenson/bats
Simply run the install script or do it manually:
bash scripts/install.sh
## Run tests
After installing all required dependencies you can start tests via:
# bats <test-file> e.g.:
bats ganggo-ganggo.tx-rx.bats
Or run all tests with a single command:
bats .
## Run images
Sometimes doing tests manually helps developing a new feature. You can run single docker images by using the helper script.
Setup the environment by executing following command once:
BATS_TEST_FILENAME=local . ./test_helper.bash
Then starting can be done by executing:
# start_app <database-name> <port> "testing_<project>"$(latest_tag <project>)
# for starting a ganggo image that could look like following:
start_app g1 9000 "testing_ganggo"$(latest_tag "ganggo")
You'll find the documentation here: [feneas.git.feneas.org/federation-testsuite](https://feneas.git.feneas.org/federation-testsuite/)
docs/Gemfile 0 → 100644
View file @ 91edba69
source "https://rubygems.org"
gem "jekyll", "~> 3.8.5"
docs/Gemfile.lock 0 → 100644
View file @ 91edba69
GEM
remote: https://rubygems.org/
specs:
addressable (2.5.2)
public_suffix (>= 2.0.2, < 4.0)
colorator (1.1.0)
concurrent-ruby (1.1.3)
em-websocket (0.5.1)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
eventmachine (1.2.7)
ffi (1.9.25)
forwardable-extended (2.6.0)
http_parser.rb (0.6.0)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
jekyll (3.8.5)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 0.7)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 2.0)
kramdown (~> 1.14)
liquid (~> 4.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
jekyll-watch (2.1.2)
listen (~> 3.0)
kramdown (1.17.0)
liquid (4.0.1)
listen (3.1.5)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
ruby_dep (~> 1.2)
mercenary (0.3.6)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (3.0.3)
rb-fsevent (0.10.3)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
rouge (3.3.0)
ruby_dep (1.5.0)
safe_yaml (1.0.4)
sass (3.7.2)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
PLATFORMS
ruby
DEPENDENCIES
jekyll (~> 3.8.5)
BUNDLED WITH
1.16.2
docs/LICENSE 0 → 100644
View file @ 91edba69
The MIT License (MIT)
Copyright (c) 2016 David Lin
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
docs/_config.yml 0 → 100644
View file @ 91edba69
nav:
- page: Federation Tests
permalink: "#federation-tests"
subnav:
- page: Projects
permalink: "#projects"
- page: Add your project
permalink: "#add-your-project"
- page: Development
permalink: "#development"
subnav:
- page: Dependencies
permalink: "#dependencies"
- page: Run tests
permalink: "#run-tests"
- page: Run images
permalink: "#run-images"
baseurl: "/federation-testsuite"
url: "https://feneas.git.feneas.org"
markdown: kramdown
kramdown:
input: GFM
docs/_includes/footer.html 0 → 100644
View file @ 91edba69
<footer class="site-footer">
<div class="container">
<div class="footer left column one-half">
<section class="small-font">
Theme <a href="https://github.com/wild-flame/jekyll-simple"> Simple </a> by <a href="http://wildflame.me">wildflame</a>
© 2016
Powered by <a href="https://github.com/jekyll/jekyll">jekyll</a>
</section>
</div>
<div class="footer right column one-half">
<section class="small-font">
{% if site.github_username %}
{% include icon-github.html username=site.github_username %}
{% endif %}
{% if site.twitter_username %}
{% include icon-twitter.html username=site.twitter_username %}
{% endif %}
</section>
</div>
</div>
</footer>
docs/_includes/head.html 0 → 100644
View file @ 91edba69
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
<meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
<!-- evil icon -->
<link rel="stylesheet" href="{{"/assets/evil-icons.min.css" | prepend:site.baseurl }}">
<script src="{{"/assets/evil-icons.min.js" | prepend:site.baseurl }}"></script>
<!-- todo: include this into main.css -->
<link rel="stylesheet" href="{{ "/css/main.css" | prepend: site.baseurl }}">
<link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}">
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}">
</head>
docs/_layouts/default.html 0 → 100644
View file @ 91edba69
<!DOCTYPE html>
<html>
{% include head.html %}
<body>
<div class="page-content">
<div class="container">
<div class="three columns">
<ul>
{% for n in site.nav %}
<li><a href="{{ n.permalink }}">{{ n.page }}</a></li>
{% if n.subnav.size > 0 %}
<ol>
{% for s in n.subnav %}
<li><a href="{{ s.permalink }}">{{ s.page }}</a></li>
{% endfor %}
</ol>
{% endif %}
{% endfor %}
</ul>
</div>
<div class="nine columns" style="z-index:100;">
<div class="wrapper">
{{ content }}
</div>
</div>
</div>
{% include footer.html %}
</div>
</body>
</html>
docs/_sass/_base.scss 0 → 100644
View file @ 91edba69
/*
* Skeleton V2.0.4
* Copyright 2014, Dave Gamache
* www.getskeleton.com
* Free to use under the MIT license.
* http://www.opensource.org/licenses/mit-license.php
* 12/29/2014
*/
/* Table of contents
––––––––––––––––––––––––––––––––––––––––––––––––––
- Grid
- Base Styles
- Typography
- Links
- Buttons
- Forms
- Lists
- Code
- Tables
- Spacing
- Utilities
- Clearing
- Media Queries
- Styled
- Framse
*/
%vertical-rhythm {
margin-bottom: $spacing-unit / 2;
}
.box {
box-sizing: border-box;
}
/* Grid
–––––––––––––––––––––––––––––––––––––––––––––––––– */
.container {
position:relative;
width: 100%;
max-width: 960px;
margin: 0 auto;
padding: 10px 10px;
box-sizing: border-box;
/* for test only */
border: 1px dashed #eeeeee;
}
.column,
.columns {
width: 100%;
float: right;
box-sizing: border-box; }
/* For devices larger than 400px */
@media (min-width: 401px) {
.container {
width: 100%;
padding: 64px 32px; }
}
/* For devices larger than 780px */
@media (min-width: 781px) {
.container {
width: 90%; }
.column,
.columns {
margin-right: 4%; }
.column:first-child,
.columns:first-child {
margin-right: 0; }
.one.column,
.one.columns { width: 4.66666666667%; }
.two.columns { width: 13.3333333333%; }
.three.columns { width: 22%; }
.four.columns { width: 30.6666666667%; }
.five.columns { width: 39.3333333333%; }
.six.columns { width: 48%; }
.seven.columns { width: 56.6666666667%; }
.eight.columns { width: 65.3333333333%; }
.nine.columns { width: 74.0%; }
.ten.columns { width: 82.6666666667%; }
.eleven.columns { width: 91.3333333333%; }
.twelve.columns { width: 100%; margin-right: 0; }
.one-third.column { width: 30.6666666667%; }
.two-thirds.column { width: 65.3333333333%; }
.one-half.column { width: 48%; }
/* Offsets */
.offset-by-one.column,
.offset-by-one.columns { margin-right: 8.66666666667%; }
.offset-by-two.column,
.offset-by-two.columns { margin-right: 17.3333333333%; }
.offset-by-three.column,
.offset-by-three.columns { margin-right: 26%; }
.offset-by-four.column,
.offset-by-four.columns { margin-right: 34.6666666667%; }
.offset-by-five.column,
.offset-by-five.columns { margin-right: 43.3333333333%; }
.offset-by-six.column,
.offset-by-six.columns { margin-right: 52%; }
.offset-by-seven.column,
.offset-by-seven.columns { margin-right: 60.6666666667%; }
.offset-by-eight.column,
.offset-by-eight.columns { margin-right: 69.3333333333%; }
.offset-by-nine.column,
.offset-by-nine.columns { margin-right: 78.0%; }
.offset-by-ten.column,
.offset-by-ten.columns { margin-right: 86.6666666667%; }
.offset-by-eleven.column,
.offset-by-eleven.columns { margin-right: 95.3333333333%; }
.offset-by-one-third.column,
.offset-by-one-third.columns { margin-right: 34.6666666667%; }
.offset-by-two-thirds.column,
.offset-by-two-thirds.columns { margin-right: 69.3333333333%; }
.offset-by-one-half.column,
.offset-by-one-half.columns { margin-right: 52%; }
}
/* Base Styles
–––––––––––––
––––––––––––––––––––––––––––––––––––– */
/* NOTE
html is set to 62.5% so that all the REM measurements throughout Skeleton
are based on 10px sizing. So basically 1.5rem = 15px :) */
html {
font-size: 62.5%; }
body {
font-size: 1.5em; /* currently ems cause chrome bug misinterpreting rems on body element */
line-height: 1.6;
font-weight: 400;
/* font-family: Helvetica, Tahoma, Arial, STXihei, "华文细黑", "Microsoft YaHei", "微软雅黑", SimSun, "宋体", Heiti, "黑体", sans-serif; */
/* font-family: "Raleway", "HelveticaNeue", "Helvetica Neue", Helvetica, Arial, sans-serif; */
font-family: -apple-system-font,"Helvetica Neue","PingFang SC","Hiragino Sans GB","Microsoft YaHei",sans-serif;
color: #222; }
/* Typography
–––––––––––––––––––––––––––––––––––––––––––––––––– */
h1, h2, h3, h4, h5, h6 {
margin-top: 2rem;
margin-bottom: 2rem;
font-weight: 400; }
h1 { font-size: 2.2rem; line-height: 1.2; letter-spacing: 0rem;}
h2 { font-size: 2.0rem; line-height: 1.25; letter-spacing: 0rem; }
h3 { font-size: 1.7rem; line-height: 1.3; letter-spacing: -.1rem; }
h4 { font-size: 1.5rem; line-height: 1.35; letter-spacing: -.08rem; }
h5 { font-size: 1.3rem; line-height: 1.5; letter-spacing: -.05rem; }
h6 { font-size: 1.1rem; line-height: 1.6; letter-spacing: 0; }
/* Larger than phablet */
@media (min-width: 550px) {
h1 { font-size: 2.4rem; }
h2 { font-size: 2.2rem; }
h3 { font-size: 2.0rem; }
h4 { font-size: 1.7rem; }
h5 { font-size: 1.4rem; }
h6 { font-size: 1.1rem; }
}
p {
margin-top: 0; }
/* Links
–––––––––––––––––––––––––––––––––––––––––––––––––– */
a {
color: #3d9970;
text-decoration: none;
//background-color: transparent;
-webkit-transition: color .4s;
transition: color .4s;
}
a:hover {
color: #b1b1b1;
text-decoration: underline;
}
// TODO
/* Buttons
–––––––––––––––––––––––––––––––––––––––––––––––––– */
.button,
button,
input[type="submit"],
input[type="reset"],
input[type="button"] {
display: inline-block;
height: 38px;
padding: 0 30px;
color: #555;
text-align: center;
font-size: 11px;
font-weight: 600;
line-height: 38px;
letter-spacing: .1rem;
text-transform: uppercase;
text-decoration: none;
white-space: nowrap;
background-color: transparent;
border-radius: 4px;
border: 1px solid #bbb;
cursor: pointer;
box-sizing: border-box; }
.button:hover,
button:hover,
input[type="submit"]:hover,
input[type="reset"]:hover,
input[type="button"]:hover,
.button:focus,
button:focus,
input[type="submit"]:focus,
input[type="reset"]:focus,
input[type="button"]:focus {
color: #333;
border-color: #888;
outline: 0; }
.button.button-primary,
button.button-primary,
input[type="submit"].button-primary,
input[type="reset"].button-primary,
input[type="button"].button-primary {
color: #FFF;
background-color: #33C3F0;
border-color: #33C3F0; }
.button.button-primary:hover,
button.button-primary:hover,
input[type="submit"].button-primary:hover,
input[type="reset"].button-primary:hover,
input[type="button"].button-primary:hover,
.button.button-primary:focus,
button.button-primary:focus,
input[type="submit"].button-primary:focus,
input[type="reset"].button-primary:focus,
input[type="button"].button-primary:focus {
color: #FFF;
background-color: #1EAEDB;
border-color: #1EAEDB; }
/* Forms
–––––––––––––––––––––––––––––––––––––––––––––––––– */
input[type="email"],
input[type="number"],
input[type="search"],
input[type="text"],
input[type="tel"],
input[type="url"],
input[type="password"],
textarea,
select {
height: 38px;
padding: 6px 10px; /* The 6px vertically centers text on FF, ignored by Webkit */
background-color: #fff;
border: 1px solid #D1D1D1;
border-radius: 4px;
box-shadow: none;
box-sizing: border-box; }
/* Removes awkward default styles on some inputs for iOS */
input[type="email"],
input[type="number"],
input[type="search"],
input[type="text"],
input[type="tel"],
input[type="url"],
input[type="password"],
textarea {
-webkit-appearance: none;
-moz-appearance: none;
appearance: none; }
textarea {
min-height: 65px;
padding-top: 6px;
padding-bottom: 6px; }
input[type="email"]:focus,
input[type="number"]:focus,
input[type="search"]:focus,
input[type="text"]:focus,
input[type="tel"]:focus,
input[type="url"]:focus,
input[type="password"]:focus,
textarea:focus,
select:focus {
border: 1px solid #33C3F0;
outline: 0; }
label,
legend {
display: block;
margin-bottom: .5rem;
font-weight: 600; }
fieldset {
padding: 0;
border-width: 0; }
input[type="checkbox"],
input[type="radio"] {
display: inline; }
label > .label-body {
display: inline-block;
margin-left: .5rem;
font-weight: normal; }
/* Lists
–––––––––––––––––––––––––––––––––––––––––––––––––– */
ul {
list-style: circle inside;
}
ol {
list-style: decimal inside; }
ol, ul {
padding-left: 0;
margin-top: 0; }
ul ul,
ul ol,
ol ol,
ol ul {
margin: 1.5rem 0 1.5rem 3rem;
font-size: 90%; }
li {
margin-bottom: 1rem; }
/* Code
–––––––––––––––––––––––––––––––––––––––––––––––––– */
code {