tuxlava 0.1.0__tar.gz

tuxlava-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+tuxlava.egg-info/
+.coverage
+.eggs/
+build/
+dist/
+env/
+/htmlcov
+public/
+/tags
+coverage.xml

tuxlava-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,187 @@
+include:
+  - '/support/docker/tuxlava-ci-images.yml'
+  - https://gitlab.com/Linaro/tuxpkg/-/raw/main/gitlab-ci-pipeline.yml
+
+variables:
+  TUXPKG_PROJECT: tuxlava
+
+stages:
+  - .pre
+  - trigger_bot_pipeline
+  - build-ci-images
+  - publish-ci-images
+  - unit-tests
+  - code-checks
+  - build
+  - test
+  - deploy
+  - .post
+
+.job:
+  image: registry.gitlab.com/linaro/tuxpkg:ci-debian
+  before_script:
+    - apt update && apt install -y python3-pip virtualenv python3-virtualenv python3-venv python3-ruamel.yaml
+    - python3 -m venv $HOME/.foo-venv
+    - source $HOME/.foo-venv/bin/activate
+    - python3 -m pip install mkdocs-material tuxpkg ruamel.yaml # FIXME not in Debian
+  script:
+  - make $CI_JOB_NAME
+
+.tuxlava:
+  except:
+    - schedules
+
+.arm64:
+  only:
+    - branches@LinaroLtd/tuxsuite.com/tuxlava
+  tags:
+    - saas-linux-medium-arm64
+
+.code-checks:
+  extends: .tuxlava
+  stage: code-checks
+  needs: []
+
+stylecheck:
+  image: $CI_REGISTRY_IMAGE:ci-debian
+  extends: .code-checks
+  stage: test
+  script:
+    - python3 -m pip install --break-system-packages -r requirements-dev.txt
+    - make stylecheck
+  except:
+    - schedules
+
+codespell:
+  extends: .code-checks
+  image: $CI_REGISTRY_IMAGE:ci-debian
+  stage: test
+  script:
+    - make spellcheck
+  except:
+    - schedules
+
+wheel:
+  image: $CI_REGISTRY_IMAGE:ci-debian
+  stage: build
+  script:
+    - flit build
+  artifacts:
+    paths:
+      - dist/*.whl
+
+.docker:
+  services:
+    - name: docker:dind
+  image: docker
+  only:
+    - tags
+  before_script:
+    - docker info
+    - docker login -u $DOCKER_USER -p $DOCKER_PASSWORD
+    - export tag="tuxlava/tuxlava:${CI_COMMIT_TAG##v}${TAG_APPEND}"
+    - export latest="tuxlava/tuxlava:latest${TAG_APPEND}"
+  script:
+    - docker build --pull --tag "${tag}" --tag "${latest}" .
+    - docker run "${tag}" tuxlava --version
+    - docker run "${latest}" tuxlava --version
+    - docker push "${tag}"
+    - docker push "${latest}"
+  needs:
+    - wheel
+
+docker-amd64:
+  extends: .docker
+  stage: deploy
+  variables:
+    TAG_APPEND: -amd64
+
+docker-arm64:
+  extends: .docker
+  stage: deploy
+  tags:
+     - saas-linux-large-arm64
+  variables:
+    TAG_APPEND: -arm64
+
+.unit-tests:
+  extends: .tuxlava
+  stage: unit-tests
+  script:
+    - pip install -r requirements-dev.txt
+    - make test
+
+unit-tests-python3.9:
+  extends: .unit-tests
+  image: $CI_REGISTRY_IMAGE:ci-python-3.9
+
+unit-tests-python3.10:
+  extends: .unit-tests
+  image: $CI_REGISTRY_IMAGE:ci-python-3.10
+
+unit-tests-python3.11:
+  extends: .unit-tests
+  image: $CI_REGISTRY_IMAGE:ci-python-3.11
+
+unit-tests-python3.12:
+  extends: .unit-tests
+  image: $CI_REGISTRY_IMAGE:ci-python-3.12
+
+unit-tests-python3.13:
+  extends: .unit-tests
+  image: $CI_REGISTRY_IMAGE:ci-python-3.13
+
+unit-tests-python3.9-arm64:
+  extends: [.unit-tests, .arm64]
+  image: $CI_REGISTRY_IMAGE:ci-python-3.9
+
+unit-tests-python3.10-arm64:
+  extends: [.unit-tests, .arm64]
+  image: $CI_REGISTRY_IMAGE:ci-python-3.10
+
+unit-tests-python3.11-arm64:
+  extends: [.unit-tests, .arm64]
+  image: $CI_REGISTRY_IMAGE:ci-python-3.11
+
+unit-tests-python3.12-arm64:
+  extends: [.unit-tests, .arm64]
+  image: $CI_REGISTRY_IMAGE:ci-python-3.12
+
+unit-tests-python3.13-arm64:
+  extends: [.unit-tests, .arm64]
+  image: $CI_REGISTRY_IMAGE:ci-python-3.13
+
+trigger_bot_pipeline:
+  stage: trigger_bot_pipeline
+  image: curlimages/curl:latest
+  script:
+    - echo "Triggering pipeline for pre-commit hook."
+    - |
+      curl -X POST \
+           -F token=$GITLABBOT_TRIGGER_TOKEN \
+           -F ref=main \
+           https://gitlab.com/api/v4/projects/$GITLABBOT_PROJECT_ID/trigger/pipeline
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
+      when: always
+
+doc:
+  extends: .job
+  stage: build
+  artifacts:
+    paths:
+      - public
+
+pages:
+  extends: .job
+  stage: deploy
+  needs:
+    - doc
+    - repository
+  artifacts:
+    paths:
+      - public
+  only:
+    - tags
+  script:
+    - cp -r dist/repo public/packages/

tuxlava-0.1.0/Dockerfile

@@ -0,0 +1,14 @@
+FROM python:3.9-slim
+
+# hadolint ignore=DL3008
+RUN apt-get update && apt-get install -y --no-install-recommends \
+        curl build-essential \
+        && apt-get clean \
+        && rm -rf /var/lib/apt/lists/*
+
+COPY dist/*.whl /
+
+# hadolint ignore=DL3013
+RUN pip --no-cache-dir install /*.whl
+
+CMD ["tuxlava", "--help"]

tuxlava-0.1.0/Dockerfile.ci-debian

@@ -0,0 +1,30 @@
+FROM debian
+ARG EXTRA_PACKAGES
+
+COPY debian/control /tuxpkg/debian/control
+
+RUN apt-get update \
+    && apt-get install -qy auto-apt-proxy \
+    && apt-get build-dep -qy /tuxpkg \
+    && apt-get install -q=2 \
+        curl \
+        black \
+        codespell \
+        flake8 \
+        flit \
+        git \
+        make \
+        mkdocs \
+        mypy \
+        python3 \
+        python3-pip \
+        ${EXTRA_PACKAGES} \
+    && true
+
+RUN if grep '^Source: tuxpkg' /tuxpkg/debian/control; then exit; fi; \
+    /usr/lib/apt/apt-helper download-file https://linaro.gitlab.io/tuxpkg/packages/signing-key.gpg /etc/apt/trusted.gpg.d/tuxpkg.gpg \
+    && echo 'deb https://linaro.gitlab.io/tuxpkg/packages/ ./' > /etc/apt/sources.list.d/tuxpkg.list \
+    && apt-get update \
+    && apt-get install -q=2 -y tuxpkg
+
+# vim: ft=dockerfile

tuxlava-0.1.0/Dockerfile.ci-fedora

@@ -0,0 +1,12 @@
+FROM fedora
+ARG EXTRA_PACKAGES
+
+COPY *.spec /tuxpkg/
+RUN dnf install -y dnf-plugins-core rpm-build git python3 python3-pip python3-yaml ${EXTRA_PACKAGES} \
+    && dnf builddep -y /tuxpkg/*.spec
+
+RUN if [ -f /tuxpkg/tuxpkg.spec ]; then exit; fi; \
+    printf '[tuxpkg]\nname=tuxpkg\ntype=rpm-md\nbaseurl=https://linaro.gitlab.io/tuxpkg/packages/\ngpgcheck=1\ngpgkey=https://linaro.gitlab.io/tuxpkg/packages/repodata/repomd.xml.key\nenabled=1\n' > /etc/yum.repos.d/tuxpkg.repo \
+    && dnf install -y tuxpkg
+
+# vim: ft=dockerfile

tuxlava-0.1.0/LICENSE

@@ -0,0 +1,19 @@
+Copyright 2024 Linaro Limited
+
+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.

tuxlava-0.1.0/Makefile

@@ -0,0 +1,40 @@
+export PROJECT := tuxlava
+export TUXPKG_MIN_COVERAGE := 95
+export TUXPKG_FLAKE8_OPTIONS := "--exclude=site-packages"
+check: spellcheck stylecheck test
+
+include $(shell tuxpkg get-makefile)
+
+.PHONY: tags
+
+help:
+	@echo 'Possible targets:'
+	@echo ''
+	@echo '  doc          - Build documentation'
+	@echo '  stylecheck   - Check code style'
+	@echo '  spellcheck   - Check code spelling'
+	@echo '  tags         - Generate an index file of the surce and test code (ctags)'
+	@echo '  test         - Run unit tests'
+
+stylecheck: style flake8
+
+spellcheck:
+	codespell \
+		-I codespell-ignore-list \
+		--check-filenames \
+		--skip '.git,public,dist,*.sw*,*.pyc,tags,*.json,.coverage,htmlcov,*.jinja2,*.yaml'
+
+doc: docs/index.md
+	mkdocs build
+
+docs/index.md: README.md scripts/readme2index.sh
+	scripts/readme2index.sh $@
+
+doc-serve:
+	mkdocs serve
+
+lava-validate:
+	python3 test/validate.py
+
+tags:
+	ctags -R $(PROJECT)/ test/

tuxlava-0.1.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.1
+Name: tuxlava
+Version: 0.1.0
+Summary: Command line tool for generating LAVA jobs
+Home-page: https://tuxsuite.com/
+Author: Senthil Kumaran
+Author-email: senthil.kumaran@linaro.org
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: MIT License
+Requires-Dist: jinja2
+Requires-Dist: requests
+Requires-Dist: PyYAML
+
+<div align="center">
+  <img src="docs/tuxlava_full.svg" alt="TuxLAVA Logo" width="40%" />
+</div>
+
+[![Pipeline Status](https://gitlab.com/Linaro/tuxrun/badges/master/pipeline.svg)](https://gitlab.com/LinaroLtd/tuxsuite.com/tuxlava/pipelines)
+[![coverage report](https://gitlab.com/Linaro/tuxrun/badges/master/coverage.svg)](https://gitlab.com/LinaroLtd/tuxsuite.com/tuxlava/commits/master)
+[![PyPI version](https://badge.fury.io/py/tuxrun.svg)](https://pypi.org/project/tuxlava/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![PyPI - License](https://img.shields.io/pypi/l/tuxrun)](https://gitlab.com/LinaroLtd/tuxsuite.com/tuxlava/blob/main/LICENSE)
+
+[Documentation](https://tuxlava.org/) - [Repository](https://gitlab.com/LinaroLtd/tuxsuite.com/tuxlava) - [Issues](https://gitlab.com/LinaroLtd/tuxsuite.com/tuxlava/-/issues)
+
+TuxLAVA, by [Linaro](https://www.linaro.org/), is a python library and
+a command line tool to generate Linaro Automated Validation
+Architecture a.k.a [LAVA](https://www.lavasoftware.org/) jobs for
+devices of the following type and has a standard list of devices that
+are supported along with tests that could be run on these devices.
+
+* AVH
+* FASTBOOT
+* FVP
+* NFS
+* QEMU
+* SSH
+
+TuxLAVA is a part of [TuxSuite](https://tuxsuite.com), a suite of
+tools and services to help with Linux kernel development.
+
+[[_TOC_]]
+
+# Installing TuxLAVA
+
+- [From PyPI](docs/install-pypi.md)
+
+# Using TuxLAVA as a library
+
+TuxLAVA can be used as a python library as follows:
+
+```shell
+#!/usr/bin/env python
+
+from tuxlava.jobs import Job
+
+job = Job(
+    device="nfs-x86_64",
+    kernel="https://example.com/bzImage",
+    rootfs="https://example.com/rootfs.tar.xz",
+    tests=["ltp-smoke", "ltp-math"],
+    modules="https://example.com/modules.tar.xz",
+    parameters={"LAVA_JOB_PRIORITY": 50},
+    timeouts={"deploy": 20},
+)
+job.initialize()
+print(job.render())
+```
+
+# Using TuxLAVA as a command line
+
+Call tuxlava as follows:
+
+```shell
+tuxlava --device nfs-x86_64 \
+    --kernel /path/or/url/to/Image
+    --modules /path/or/url/to/modules /usr/ \
+    --rootfs /path/or/url/to/rootfs \
+    --tests boot
+```
+
+TuxLAVA will output the LAVA job to the stdout with the provided
+arguments for x86_64 device
+
+The complete list of tuxlava options is available with the following
+command:
+
+```shell
+tuxlava --help
+```
+
+# Examples
+
+LAVA job to boot test a mipsel kernel at https://mykernel.org/vmlinux:
+
+```shell
+tuxlava --device qemu-mips32el \
+    --kernel https://mykernel.org/vmlinux
+```
+
+Generate a LAVA job with *ltp-smoke* test:
+
+```shell
+tuxlava --device qemu-mips32el \
+    --kernel https://mykernel.org/vmlinux \
+    --test ltp-smoke
+```
+

tuxlava-0.1.0/README.md

@@ -0,0 +1,94 @@
+<div align="center">
+  <img src="docs/tuxlava_full.svg" alt="TuxLAVA Logo" width="40%" />
+</div>
+
+[![Pipeline Status](https://gitlab.com/Linaro/tuxrun/badges/master/pipeline.svg)](https://gitlab.com/LinaroLtd/tuxsuite.com/tuxlava/pipelines)
+[![coverage report](https://gitlab.com/Linaro/tuxrun/badges/master/coverage.svg)](https://gitlab.com/LinaroLtd/tuxsuite.com/tuxlava/commits/master)
+[![PyPI version](https://badge.fury.io/py/tuxrun.svg)](https://pypi.org/project/tuxlava/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![PyPI - License](https://img.shields.io/pypi/l/tuxrun)](https://gitlab.com/LinaroLtd/tuxsuite.com/tuxlava/blob/main/LICENSE)
+
+[Documentation](https://tuxlava.org/) - [Repository](https://gitlab.com/LinaroLtd/tuxsuite.com/tuxlava) - [Issues](https://gitlab.com/LinaroLtd/tuxsuite.com/tuxlava/-/issues)
+
+TuxLAVA, by [Linaro](https://www.linaro.org/), is a python library and
+a command line tool to generate Linaro Automated Validation
+Architecture a.k.a [LAVA](https://www.lavasoftware.org/) jobs for
+devices of the following type and has a standard list of devices that
+are supported along with tests that could be run on these devices.
+
+* AVH
+* FASTBOOT
+* FVP
+* NFS
+* QEMU
+* SSH
+
+TuxLAVA is a part of [TuxSuite](https://tuxsuite.com), a suite of
+tools and services to help with Linux kernel development.
+
+[[_TOC_]]
+
+# Installing TuxLAVA
+
+- [From PyPI](docs/install-pypi.md)
+
+# Using TuxLAVA as a library
+
+TuxLAVA can be used as a python library as follows:
+
+```shell
+#!/usr/bin/env python
+
+from tuxlava.jobs import Job
+
+job = Job(
+    device="nfs-x86_64",
+    kernel="https://example.com/bzImage",
+    rootfs="https://example.com/rootfs.tar.xz",
+    tests=["ltp-smoke", "ltp-math"],
+    modules="https://example.com/modules.tar.xz",
+    parameters={"LAVA_JOB_PRIORITY": 50},
+    timeouts={"deploy": 20},
+)
+job.initialize()
+print(job.render())
+```
+
+# Using TuxLAVA as a command line
+
+Call tuxlava as follows:
+
+```shell
+tuxlava --device nfs-x86_64 \
+    --kernel /path/or/url/to/Image
+    --modules /path/or/url/to/modules /usr/ \
+    --rootfs /path/or/url/to/rootfs \
+    --tests boot
+```
+
+TuxLAVA will output the LAVA job to the stdout with the provided
+arguments for x86_64 device
+
+The complete list of tuxlava options is available with the following
+command:
+
+```shell
+tuxlava --help
+```
+
+# Examples
+
+LAVA job to boot test a mipsel kernel at https://mykernel.org/vmlinux:
+
+```shell
+tuxlava --device qemu-mips32el \
+    --kernel https://mykernel.org/vmlinux
+```
+
+Generate a LAVA job with *ltp-smoke* test:
+
+```shell
+tuxlava --device qemu-mips32el \
+    --kernel https://mykernel.org/vmlinux \
+    --test ltp-smoke
+```

tuxlava-0.1.0/codespell-ignore-list

@@ -0,0 +1 @@
+damon

tuxlava-0.1.0/debian/changelog

@@ -0,0 +1,5 @@
+tuxlava (0.1.0-1) UNRELEASED; urgency=medium
+
+  * Initial release
+
+ -- Senthil Kumaran <senthil.kumaran@linaro.org>  Mon, 03 Feb 2025 20:00:00 +0530

tuxlava-0.1.0/debian/control

@@ -0,0 +1,28 @@
+Source: tuxlava
+Maintainer: Senthil Kumaran <senthil.kumaran@linaro.org>
+Section: python
+Priority: optional
+Build-Depends: debhelper-compat (= 13),
+               dh-python,
+               flit,
+               wget,
+               python3-all,
+               python3-pytest,
+               python3-pytest-cov,
+               python3-pytest-mock,
+               python3-flask
+Standards-Version: 3.9.6
+Homepage: https://tuxsuite.com/
+
+Package: tuxlava
+Architecture: all
+Depends: python3 (>= 3.6),
+         python3-attr,
+         python3-requests,
+         python3-yaml,
+         ${misc:Depends},
+         ${python3:Depends},
+Description: TuxLAVA is a python library and tool to generate LAVA jobs for
+  devices of type qemu, fvp, fastboot and nfs. TuxLAVA has standard list of
+  devices that are supported along with tests that could be run on these
+  devices.

tuxlava-0.1.0/debian/gbp.conf

@@ -0,0 +1,5 @@
+[DEFAULT]
+ignore-branch = True
+pristine-tar = False
+upstream-tree = TAG
+upstream-tag = v%(version)s

tuxlava-0.1.0/debian/rules

@@ -0,0 +1,21 @@
+#!/usr/bin/make -f
+
+export PYBUILD_NAME = tuxlava
+
+export PYBUILD_TEST_PYTEST = 1
+export PYBUILD_TEST_ARGS = test/
+export LC_ALL = C.UTF-8
+
+# Support non-flit builds - requires setup.py to be present (which is the case
+# in pypi release tarballs)
+ifneq ($(shell pybuild --list-systems | grep flit),)
+export PYBUILD_SYSTEM = flit
+endif
+
+%:
+	dh $@ --with python3 --buildsystem=pybuild
+
+# FIXME this should not be necessary with PYBUILD_TEST_PYTEST = 1 above
+# but I can't get it to work for some reason.
+override_dh_auto_test:
+	for p in $$(py3versions --supported); do $$p -m pytest test/; done

tuxlava-0.1.0/debian/source/format

@@ -0,0 +1 @@
+3.0 (quilt)