Feature/issue 1381 boardfarm in gitlab ci by odkq · Pull Request #1483 · prplfoundation/prplMesh

odkq · 2020-06-24T21:34:58Z

https://jira.prplfoundation.org/browse/PPM-30

To run the boardfarm tests, we need an image containing boardfarm. Add an image that contains all the boardfarm dependencies, fetch a specific commit (the latest one from the master branch) and install it. The dockerfile was adapted from the existing work on: #1483 Also add the image to .gitlab-ci to get it built automatically. Signed-off-by: Raphaël Mélotte <raphael.melotte@mind.be>

When a command failed to run, raise an exception early, and add the stdout and stderr output of the command in the message. These changes were taken and adapted from: #1483 Signed-off-by: Raphaël Mélotte <raphael.melotte@mind.be>

arnout

Not a full review - just a few loose comments. Please also see my comments in #1492 (review) where they're relevant for this one.

I don't really like this docker compose approach to launch several containers. Indeed, it forces us to duplicate the "knowledge" of which containers to use between the compose.yml file and the boardfarm config file. However, I do look how the compose yml file describes how to launch the container much better than how the shell script does it. So I'm all for using that rather than shell scripts to launch our containers. Wouldn't it be possible to make two compose.yml files, one for boardfarm itself and one for prplmesh, and do a compose boardfarm which launches boardfarm which launches two times compose prplmesh which luanches agent resp. controller?

arnout · 2020-06-29T16:52:27Z

dctest.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+function dc {


dc is already an existing tool (decimal calculator, I think), so better call it something unique. "compose" for example.

arnout · 2020-06-29T16:53:48Z

dctest.sh

+if [ $# -eq 0 ]; then
+    dc up boardfarm
+else
+    if [ $1 == "-h" ]; then


I believe shellcheck will complain here...

Suggested change

if [ $1 == "-h" ]; then

if [ "$1" == "-h" ]; then

arnout · 2020-06-29T16:58:06Z

tools/docker/boardfarm-ci/docker-compose.yml

+version: '3'
+services:
+    controller:
+        image: registry.gitlab.com/prpl-foundation/prplmesh/prplmesh-runner


We'll need an explicit tag here as well. Is there a way for docker-compose to get variables that get expanded? Like ARG in Dockerfile?

arnout · 2020-06-29T16:59:38Z

tools/docker/boardfarm-ci/docker-compose.yml

+        image: registry.gitlab.com/prpl-foundation/prplmesh/prplmesh-runner
+        privileged: true    # For the creation of the bridge to work
+        container_name: controller
+        environment:
+            - USER=$USER
+            - INSTALL_DIR=$ROOT_DIR/build/install
+            - ROOT_DIR=$ROOT_DIR
+        expose:
+            - "5000"
+            - "8002"
+        volumes:
+            - "$ROOT_DIR:$ROOT_DIR"
+        entrypoint: ["/root/entrypoint.sh", "/usr/bin/start-controller-agent"]


OMG, this is a lot more readable than the stupid run script we have now... Nice!

arnout · 2020-06-29T17:06:41Z

tests/boardfarm_plugins/boardfarm_prplmesh/devices/prplmesh_compose.py

+rootdir = os.path.abspath(os.path.join(os.path.dirname(__file__), '../../../..'))
+
+
+class PrplMeshCompose(PrplMeshBase):


I don't think we should define a new class. Instead, change the PrplMeshDocker class to use compose instead of naked docker.

When a command failed to run, raise an exception early, and add the stdout and stderr output of the command in the message. These changes were taken and adapted from: #1483 Signed-off-by: Raphaël Mélotte <raphael.melotte@mind.be>

test requirements and controller Signed-off-by: odkq <pablo@odkq.com>

Signed-off-by: odkq <pablo@odkq.com>

Signed-off-by: Raphaël Mélotte <raphael.melotte@mind.be> Signed-off-by: odkq <pablo@odkq.com>

Export $ROOT_DIR into images Signed-off-by: odkq <pablo@odkq.com>

Signed-off-by: odkq <pablo@odkq.com>

For dumpcap Signed-off-by: odkq <pablo@odkq.com>

With this, many instances can be launched. Each one get's the name configured in the .json file, with the 'unique id' being the user. Also, a volume is mapped where the tests expect the output log to reside, from them to /tmp/user/beerocks/logs Changed the entrypoint for boardfarm image to run the script and and made a small shell script wrapper Signed-off-by: odkq <pablo@odkq.com>

Signed-off-by: odkq <pablo@odkq.com>

…ithub.com/prplfoundation/prplMesh into feature/issue-1381-boardfarm-in-gitlab-ci Signed-off-by: odkq <pablo@odkq.com>

Signed-off-by: odkq <pablo@odkq.com>

To test dctest.py

To test dctest.py Signed-off-by: odkq <pablo@odkq.com>

…ithub.com/prplfoundation/prplMesh into feature/issue-1381-boardfarm-in-gitlab-ci Signed-off-by: odkq <pablo@odkq.com>

added tag 'boardfarm-compose' to dctest_one_test target Signed-off-by: odkq <pablo@odkq.com>

This allows for gitlab-ci to report a failing test Signed-off-by: odkq <pablo@odkq.com>

Use 'latest' tag when testing locally (not in gitlab-ci) Signed-off-by: pablo <pablo@odkq.com>

Forward the variable so it is used to tag the images for the runner and agent inside boardfarm container Signed-off-by: pablo <pablo@odkq.com>

After running dctest.py, make sure the files created while building boardfarm (as root) can be removed later by gitlab-runner Signed-off-by: pablo <pablo@odkq.com>

before exiting the script. Adding it in .gitlab-ci.yml did not work as when the script fails next lines are not executed Signed-off-by: pablo <pablo@odkq.com>

When it runs inside gitlab-ci, the directory is /tmp/beerocks/logs, not /tmp/<user>/beerocks/logs Signed-off-by: pablo <pablo@odkq.com>

Signed-off-by: pablo <pablo@odkq.com>

To /builds/prpl-foundation/prplMesh which is the one expected by the runner and binaries built Signed-off-by: pablo <pablo@odkq.com>

Signed-off-by: pablo <pablo@odkq.com>

Setting the current uid and the group id of docker (to be able to access the docker socket), this makes all the files created by the boardfarm installation deletable by the gitlab-ci user Signed-off-by: pablo <pablo@odkq.com>

This appeared after merging from master Signed-off-by: pablo <pablo@odkq.com>

rmelotte · 2020-08-03T14:29:42Z

@odkq can you please:

fix the shellcheck and flake8 issues that are reported on Gitlab: https://gitlab.com/prpl-foundation/prplMesh/-/pipelines/173659597
make sure your "Signed-off-by" is there for every commit

Then we will have to cleanup the history (at least the easy parts), merge it, then do additional cleanup like removing the old boardfarm test, and integrating #1556.

Alternative entrypoint for the runner image when running as a regular user Signed-off-by: pablo <pablo@odkq.com>

Signed-off-by: pablo <pablo@odkq.com>

rmelotte · 2020-08-04T14:52:00Z

tests/boardfarm_plugins/boardfarm_prplmesh/devices/prplmesh_compose.py

+                                 "run", "start-controller")
+            time.sleep(self.delay)
+            self.controller_entity = \
+                ALEntityDocker(self.name, is_controller=True, compose=True)


Suggested change

ALEntityDocker(self.name, is_controller=True, compose=True)

ALEntityDocker(self.name, device=self, is_controller=True, compose=True)

To run the boardfarm tests, we need an image containing boardfarm. Add an image that contains all the boardfarm dependencies, fetch a specific commit (the latest one from the master branch) and install it. The dockerfile was adapted from the existing work on: #1483 Also add the image to .gitlab-ci to get it built automatically. Signed-off-by: Raphaël Mélotte <raphael.melotte@mind.be>

When a command failed to run, raise an exception early, and add the stdout and stderr output of the command in the message. These changes were taken and adapted from: #1483 Signed-off-by: Raphaël Mélotte <raphael.melotte@mind.be>

rmelotte · 2020-08-13T14:17:13Z

Superseded by #1587

arnout assigned odkq Jun 25, 2020

arnout added this to the M3 - Workable product milestone Jun 25, 2020

arnout linked an issue Jun 25, 2020 that may be closed by this pull request

[TASK] Integrate boardfarm in gitlab-ci #1381

Closed

4 tasks

odkq marked this pull request as ready for review June 29, 2020 15:16

odkq requested review from arnout, kantera800, morantr, rmelotte, tomereli and vitalybu as code owners June 29, 2020 15:16

arnout reviewed Jun 29, 2020

View reviewed changes

rmelotte mentioned this pull request Jun 30, 2020

Feature/ci run boardfarm #1492

Merged

odkq force-pushed the feature/issue-1381-boardfarm-in-gitlab-ci branch from 87ddfba to 2ff49e2 Compare June 30, 2020 14:56

odkq and others added 8 commits July 1, 2020 10:39

boardfarm-ci: Run boardfarm into docker-compose

6db5f04

test requirements and controller Signed-off-by: odkq <pablo@odkq.com>

boardfarm-ci: Use docker-compose from within boardfarm

c904291

Signed-off-by: odkq <pablo@odkq.com>

boardfarm-ci: docker-compose.yml: use a variable for the volumes

1371353

Signed-off-by: Raphaël Mélotte <raphael.melotte@mind.be> Signed-off-by: odkq <pablo@odkq.com>

boardfarm-ci: Add exit status check in _run_shell_cmd

2c43b82

Export $ROOT_DIR into images Signed-off-by: odkq <pablo@odkq.com>

boardfarm-ci: Preliminary version of prplmesh_compose.py

3bfd97d

Signed-off-by: odkq <pablo@odkq.com>

boardfarm-ci: Made the boardfarm container privileged

f677601

For dumpcap Signed-off-by: odkq <pablo@odkq.com>

boardfarm-ci: Fix dctest.sh --clean

6d796bf

Signed-off-by: odkq <pablo@odkq.com>

odkq added 19 commits July 24, 2020 13:10

boardfarm-ci: Added dctest to .gitlab-ci.yml

064cb83

Signed-off-by: odkq <pablo@odkq.com>

Merge branch 'feature/issue-1381-boardfarm-in-gitlab-ci' of https://g…

2abaf13

…ithub.com/prplfoundation/prplMesh into feature/issue-1381-boardfarm-in-gitlab-ci Signed-off-by: odkq <pablo@odkq.com>

boardfarm-ci: Correct dependency on .run-test-dctest

f2be16f

Signed-off-by: odkq <pablo@odkq.com>

boardfarm-ci: Temporary replace bcl_unit_tests

061a26b

To test dctest.py

boardfarm-ci: Temporary replace bcl_unit_tests

de9ecff

To test dctest.py Signed-off-by: odkq <pablo@odkq.com>

Merge branch 'feature/issue-1381-boardfarm-in-gitlab-ci' of https://g…

f1c2462

…ithub.com/prplfoundation/prplMesh into feature/issue-1381-boardfarm-in-gitlab-ci Signed-off-by: odkq <pablo@odkq.com>

boardfarm-ci: Added correct tag in .gitlab-ci.yml

7acc63c

added tag 'boardfarm-compose' to dctest_one_test target Signed-off-by: odkq <pablo@odkq.com>

boardfarm-ci: Return != 0 when inner process do so

62a558b

This allows for gitlab-ci to report a failing test Signed-off-by: odkq <pablo@odkq.com>

Use $CI_PIPELINE_ID tag for runner images.

7252294

Use 'latest' tag when testing locally (not in gitlab-ci) Signed-off-by: pablo <pablo@odkq.com>

boardfarm-ci: Forward the CI_PIPELINE_ID var

caca5dd

Forward the variable so it is used to tag the images for the runner and agent inside boardfarm container Signed-off-by: pablo <pablo@odkq.com>

boardfarm-ci: Change owner of files to gitlab-runner

e273782

After running dctest.py, make sure the files created while building boardfarm (as root) can be removed later by gitlab-runner Signed-off-by: pablo <pablo@odkq.com>

boardfarm-ci: Change ownership of the files

08d1eb6

before exiting the script. Adding it in .gitlab-ci.yml did not work as when the script fails next lines are not executed Signed-off-by: pablo <pablo@odkq.com>

boardfarm-ci: Change destination for log directory

6d3872b

When it runs inside gitlab-ci, the directory is /tmp/beerocks/logs, not /tmp/<user>/beerocks/logs Signed-off-by: pablo <pablo@odkq.com>

boardfarm-ci: missing import

c90f303

Signed-off-by: pablo <pablo@odkq.com>

boardfarm-ci: Set the ROOT_DIR and INSTALL_DIR

aae5f1b

To /builds/prpl-foundation/prplMesh which is the one expected by the runner and binaries built Signed-off-by: pablo <pablo@odkq.com>

boardfarm-ci: Do not try to chown from .gitlab-ci.yml

9b04699

Signed-off-by: pablo <pablo@odkq.com>

boardfarm-ci: Run boardfarm as a regular user

fffe5d4

Setting the current uid and the group id of docker (to be able to access the docker socket), this makes all the files created by the boardfarm installation deletable by the gitlab-ci user Signed-off-by: pablo <pablo@odkq.com>

Merge branch 'master' into feature/issue-1381-boardfarm-in-gitlab-ci

ace76de

boardfarm-ci: Fixed 'missing device' bug

858e5e8

This appeared after merging from master Signed-off-by: pablo <pablo@odkq.com>

rmelotte marked this pull request as draft August 3, 2020 14:50

odkq added 4 commits August 3, 2020 17:26

boardfarm-ci: Removed unused shell script

6456dc3

Alternative entrypoint for the runner image when running as a regular user Signed-off-by: pablo <pablo@odkq.com>

boardfarm-ci: Fix device parameter passing

6cb135f

Signed-off-by: pablo <pablo@odkq.com>

boardfarm-ci: Shellcheck fixes

98974a9

Signed-off-by: pablo <pablo@odkq.com>

boardfarm-ci: Fixes for PEP-8 compliance

9122a23

Signed-off-by: pablo <pablo@odkq.com>

rmelotte reviewed Aug 4, 2020

View reviewed changes

rmelotte closed this Aug 13, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/issue 1381 boardfarm in gitlab ci#1483

Feature/issue 1381 boardfarm in gitlab ci#1483
odkq wants to merge 52 commits intomasterfrom
feature/issue-1381-boardfarm-in-gitlab-ci

odkq commented Jun 24, 2020 •

edited by rmelotte

Loading

Uh oh!

arnout left a comment

Uh oh!

arnout Jun 29, 2020

Uh oh!

arnout Jun 29, 2020

Uh oh!

arnout Jun 29, 2020

Uh oh!

arnout Jun 29, 2020

Uh oh!

arnout Jun 29, 2020

Uh oh!

rmelotte commented Aug 3, 2020

Uh oh!

rmelotte Aug 4, 2020

Uh oh!

rmelotte commented Aug 13, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		rootdir = os.path.abspath(os.path.join(os.path.dirname(__file__), '../../../..'))


		class PrplMeshCompose(PrplMeshBase):

	ALEntityDocker(self.name, is_controller=True, compose=True)
	ALEntityDocker(self.name, device=self, is_controller=True, compose=True)

		@@ -0,0 +1,14 @@
		#!/bin/bash

		function dc {

Conversation

odkq commented Jun 24, 2020 • edited by rmelotte Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

arnout left a comment

Choose a reason for hiding this comment

Uh oh!

arnout Jun 29, 2020

Choose a reason for hiding this comment

Uh oh!

arnout Jun 29, 2020

Choose a reason for hiding this comment

Uh oh!

arnout Jun 29, 2020

Choose a reason for hiding this comment

Uh oh!

arnout Jun 29, 2020

Choose a reason for hiding this comment

Uh oh!

arnout Jun 29, 2020

Choose a reason for hiding this comment

Uh oh!

rmelotte commented Aug 3, 2020

Uh oh!

rmelotte Aug 4, 2020

Choose a reason for hiding this comment

Uh oh!

rmelotte commented Aug 13, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

odkq commented Jun 24, 2020 •

edited by rmelotte

Loading