add script to monitor test-images directory for new test images

.env

@@ -1,3 +1,3 @@
 DC_POSTGRES_IMAGE=postgres:11.2-alpine
-DC_SERVER_IMAGE=lavasoftware/lava-server:2019.04
-DC_DISPATCHER_IMAGE=lavasoftware/lava-dispatcher:2019.04
+DC_SERVER_IMAGE=lavasoftware/lava-server:2019.06
+DC_DISPATCHER_IMAGE=lavasoftware/lava-dispatcher:2019.06

Makefile

@@ -1,6 +1,74 @@
+# Host address on which LAVA is accessible.
+LAVA_HOST = localhost
+# LAVA user to create/use.
+LAVA_USER = admin
+# lavacli "identity" (cached credential name) for the above user, to submit jobs
+# "dispatcher" is legacy name from the original instructions.
+LAVA_IDENTITY = dispatcher
+
+
 all:
+	contrib/monitor-images.sh $(LAVA_IDENTITY) &
+	sudo contrib/udev-forward.py -i lava-dispatcher &
 	docker-compose up
 
+stop:
+	pkill -f monitor-images.sh
+	-sudo pkill udev-forward.py
+	docker-compose stop
+
 clean:
+	pkill -f monitor-images.sh
+	-sudo pkill udev-forward.py
 	docker-compose rm -vsf
 	docker volume rm -f lava-server-pgdata lava-server-joboutput lava-server-devices lava-server-health-checks
+
+# Create various board configs for connected board(s). Supposed to be done
+# before "install" target.
+board-configs:
+	@echo "Note: you should have *all* of your boards connected to USB before running this."
+	@echo "Press Ctrl+C to break if not. Review results carefully afterwards."
+	@read dummy
+	-mv ser2net/ser2net.conf ser2net/ser2net.conf.old
+	touch ser2net/ser2net.conf
+	@echo
+	contrib/make-board-files.sh devices
+
+install:
+	sudo cp contrib/LAVA.rules /etc/udev/rules.d/
+	sudo cp contrib/usb-passthrough /usr/local/bin/
+	sudo udevadm control --reload
+
+lava-setup: lava-user lava-identity lava-boards
+
+lava-user:
+	@echo -n "Input LAVA admin user passwd: "; \
+	read passwd; \
+	test -n "$$passwd" && docker exec -it lava-server lava-server manage users add $(LAVA_USER) --superuser --staff --passwd $$passwd || true
+	@echo
+	@echo "Now login at http://$(LAVA_HOST)/accounts/login/?next=/api/tokens/ and create an auth token (long sequence of chars)"
+	-xdg-open http://$(LAVA_HOST)/accounts/login/?next=/api/tokens/
+
+lava-identity:
+	@echo
+	@echo -n "Enter auth token: "; \
+	read token; \
+	test -n "$$token" && lavacli identities add --username $(LAVA_USER) --token $$token --uri http://$(LAVA_HOST)/RPC2 $(LAVA_IDENTITY) || true
+	lavacli -i dispatcher system version
+
+lava-boards:
+	-lavacli -i $(LAVA_IDENTITY) device-types add frdm-k64f
+	-lavacli -i $(LAVA_IDENTITY) devices add --type frdm-k64f --worker lava-dispatcher frdm-k64f-01
+	lavacli -i $(LAVA_IDENTITY) devices dict set frdm-k64f-01 devices/frdm-k64f-01.jinja2
+	-lavacli -i $(LAVA_IDENTITY) device-types add qemu
+	-lavacli -i $(LAVA_IDENTITY) devices add --type qemu --worker lava-dispatcher qemu-01
+	lavacli -i $(LAVA_IDENTITY) devices dict set qemu-01 devices/qemu-01.jinja2
+
+	-lavacli -i $(LAVA_IDENTITY) device-types add musca_a
+	lavacli -i $(LAVA_IDENTITY) device-types template set musca_a device-types/musca_a.jinja2
+
+testjob:
+	lavacli -i dispatcher jobs submit example/lava.job
+
+dispatcher-shell:
+	docker exec -it lava-dispatcher bash

contrib/LAVA.rules

@@ -0,0 +1,10 @@
+# Example LAVA.rules for USB passthrough to container
+#
+# Assumes that usb-passthrough script is installed in
+# /usr/local/bin/passthrough
+
+# Pass all usb devices (TTY, block, CDC) to lava-dispatcher container
+# FRDM-K64F
+ACTION=="add", ENV{ID_SERIAL_SHORT}=="MYSERIALNUM", RUN+="/usr/local/bin/usb-passthrough -a -d %E{ID_SERIAL_SHORT} -i lava-dispatcher"
+# Pass TTY through to lava-ser2net container
+ACTION=="add", SUBSYSTEM=="tty", ENV{ID_SERIAL_SHORT}=="MYSERIALNUM", RUN+="/usr/local/bin/usb-passthrough -a -d %E{ID_SERIAL_SHORT} -i lava-ser2net"

contrib/board-setup-helper.py

@@ -0,0 +1,118 @@
+#!/usr/bin/python3
+
+#  Copyright 2019 Linaro Limited
+#  Author: Kumar Gala <kumar.gala@linaro.org>
+
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; either version 2 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+#  MA 02110-1301, USA.
+
+import pyudev
+import argparse
+import os
+import pprint
+
+def ser2net(dev, ser2net_file):
+    ser2net = {}
+    port_num = 5001
+
+    with open(ser2net_file, 'r') as fd:
+        for line in fd:
+            line = line.strip()
+            values = line.split(':')
+            port = int(values.pop(0))
+            ser2net[port] = values
+
+    if len(ser2net):
+        port_num = max(ser2net.keys()) + 1
+
+    new_device = True
+
+    for k in ser2net:
+        if dev in ser2net[k][2]:
+            new_device = False
+            print("WARNING: device %s already exists in %s on port %d" % (dev, ser2net_file, k))
+            port_num = k
+
+    if new_device:
+        with open(ser2net_file, 'a') as fd:
+            fd.write("%d:telnet:0:%s:115200 8DATABITS NONE 1STOPBIT LOCAL max-connections=10\n" % (port_num, dev))
+
+    return port_num
+
+def get_device_numbers(serial_no, dev_type, board_file, ser2net_file):
+    result = None, None
+    context = pyudev.Context()
+
+    devices = context.list_devices()
+
+    board_jinja = open(board_file, 'w')
+
+    board_jinja.write("{%% extends '%s.jinja2' %%}\n" % dev_type)
+    board_jinja.write("{%% set board_id = '%s' %%}\n" % serial_no)
+
+    for device in devices:
+        serial = device.attributes.get("serial")
+        if serial is not None and serial_no in serial.decode("utf-8"):
+            child = device.children
+            for c in child:
+                if (c.subsystem == "block"):
+                    for l in c.device_links:
+                        if "by-id" in l:
+                            board_jinja.write("{%% set usb_mass_device = '%s' %%}\n" % l)
+
+                if (c.subsystem == "tty"):
+                    for l in c.device_links:
+                        if "by-id" in l:
+                            port = ser2net(l, ser2net_file)
+                            if port:
+                                board_jinja.write("{%% set connection_command = 'telnet ser2net %d' %%}\n" % port)
+            break
+
+    if dev_type == "frdm-k64f":
+        board_jinja.write("{% set resets_after_flash = false %}\n")
+
+
+def main():
+    parser = argparse.ArgumentParser(description='LAVA board helper', add_help=False)
+
+    parser.add_argument("-d", "--device_serial_num", type=str, required=True,
+                        help="Devices serial number")
+
+    parser.add_argument("-t", "--device_type", type=str, required=True,
+                        help="Devices type")
+
+    parser.add_argument("-s", "--ser2net_conf", type=str, required=False,
+                        default = "./ser2net/ser2net.conf",
+                        help="ser2net configuration file")
+
+    parser.add_argument("-u", dest='udev', default=False, action='store_true')
+
+    parser.add_argument("-b", "--board_file", type=str, required=False,
+                        default = "board.jinja2",
+                        help="board jinja file")
+
+    options = parser.parse_args()
+
+    get_device_numbers(options.device_serial_num, options.device_type,
+                       options.board_file, options.ser2net_conf)
+
+    if (options.udev):
+        print('ACTION=="add", ENV{ID_SERIAL_SHORT}=="%s", RUN+="/usr/local/bin/usb-passthrough -a -d %%E{ID_SERIAL_SHORT} -i lava-dispatcher"' % options.device_serial_num)
+        print('ACTION=="add", SUBSYSTEM=="tty", ENV{ID_SERIAL_SHORT}=="%s", RUN+="/usr/local/bin/usb-passthrough -a -d %%E{ID_SERIAL_SHORT} -i lava-ser2net"' % options.device_serial_num)
+
+
+
+if __name__ == '__main__':
+    main()

contrib/make-board-files.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+if [ -z "$1" ]; then
+    echo "Usage: $0 <devices_dir>"
+    exit 1
+fi
+
+for ser in $1/*.serial; do
+    echo "Processing: $ser"
+    devname=$(basename $ser .serial)
+    devtype=$(echo $devname | python -c "import sys; print(sys.stdin.readline().rsplit('-', 1)[0])")
+    contrib/board-setup-helper.py -d $(cat $ser) -t $devtype -b $1/$devname.jinja2 -u >contrib/LAVA.rules
+done

contrib/monitor-images.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+# Usage: ./monitor-images.sh <your LAVA identity>
+#
+#   This script monitors the 'test-images' directory for any file that is
+#   dropped into it. It assumes the directory layout is
+#   test-images/<device-type>, and upon detecting a new file, uses the
+#   corresponding job template in job-templates/lava_<device-type>.job
+#   to submit the job with the provided LAVA identity.
+#
+#   '<test_image>' in the template is automatically substituted with the
+#   actual path to the test image.
+
+contrib_dir=`dirname $0`
+dir=test-images
+template_dir=job-templates
+
+cd $contrib_dir/..
+
+inotifywait -r -m "$dir" -e close_write --format '%w%f' |
+    while IFS=' ' read -r fname
+    do
+        IFS='/'
+        read -ra path <<< "$fname"
+        template="$template_dir"/lava_"${path[1]}".job
+        if [ ! -f "$template" ]
+        then
+            #if no template found for the device-type, do nothing
+            continue
+        fi
+
+        echo "Using template for device type ${path[1]}:"
+        echo "    $template"
+
+        # Replace <test_image> with actual path to test image
+        sed_cmd=s/\<test_image\>/"file:\/\/\/${fname//\//\\\/}"/g
+
+        tmp_file=$(mktemp)
+        echo "Submitting job for $fname"
+        [ -f "$fname" ] && sed "$sed_cmd" "$template" > "$tmp_file" && lavacli -i $1 jobs submit "$tmp_file" && rm "$tmp_file"
+    done