YunoHost/package_check
1
0
Fork 0
mirror of https://github.com/YunoHost/package_check.git synced 2024-09-03 20:06:20 +02:00
Code Issues Projects Releases Packages Wiki Activity

Tweak preinstall/preupgrade syntax + document new tests.toml syntax

Browse source
This commit is contained in:
Alexandre Aubin 2023-01-20 00:26:40 +01:00
parent 6a0f807b35
commit d2529fee7e
2 changed files with 81 additions and 101 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

172
README.md
View file

@ -29,6 +29,26 @@ For a package on GitHub: `./package_check.sh https://github.com/YunoHost-Apps/AP
You need to provide, at the root of the package, a `check_process` file to help the script to test the package with the correct arguments. You need to provide, at the root of the package, a `check_process` file to help the script to test the package with the correct arguments.
If this file is not present, package_check will be used in downgraded mode. It will try to retrieve domain, path and admin user arguments in the manifest and execute some tests, based on the arguments it can find. If this file is not present, package_check will be used in downgraded mode. It will try to retrieve domain, path and admin user arguments in the manifest and execute some tests, based on the arguments it can find.
## Usage
```text
> ./package_check.sh --help
Usage: package_check.sh [OPTION]... PACKAGE_TO_CHECK
-b, --branch=BRANCH Specify a branch to check.
-a, --arch=ARCH
-d, --dist=DIST
-y, --ynh-branch=BRANCH
-i, --interactive Wait for the user to continue before each remove
-e, --interactive-on-errors Wait for the user to continue on errors
-s, --force-stop Force the stop of running package_check
-r, --rebuild (Re)Build the base container
(N.B.: you're not supposed to use this option,
images are supposed to be fetch from
devbaseimgs.yunohost.org automatically)
-h, --help Display this help
```
## Deploying package_check ## Deploying package_check
First you need to install the system dependencies. First you need to install the system dependencies.
@ -137,103 +157,63 @@ lxc exec inspired-lamprey -- dpkg --print-architecture
If the `build_base_lxc.sh` script detects that you are trying a cross container architecture, it will try to perform this hack If the `build_base_lxc.sh` script detects that you are trying a cross container architecture, it will try to perform this hack
## Syntax of `check_process` ## `tests.toml` syntax
> Except spaces, the syntax of this file must be respected. ```toml
test_format = 1.0
``` [default]
;; Default test serie
# Comment ignored # ------------
; pre-install # Tests to run
set -euxo pipefail # ------------
echo -n "Here your commands to execute in the container"
echo ", before each installation of the app." # NB: the tests to run are automatically deduced by the CI script according to the
; pre-upgrade # content of the app's manifest. The declarations below allow to customize which
set -euxo pipefail # tests are ran, possibly add special test suite to test special args, or
if [ "$FROM_COMMIT" == '65c382d138596fcb32b4c97c39398815a1dcd4e8' ] # declare which commits to test upgrade from.
then #
resolve=127.0.0.1:443:$DOMAIN # You can also decide (though this is discouraged!) to ban/ignore some tests,
# Example of request using curl
curl -X POST --data '{"some-key": "some-value"}' https://$DOMAIN/$PATH --resolve "$resolve" exclude = ["install.private", "install.multi"] # NB : you should NOT need this except if you really have a good reason ...
fi
; Manifest # For special usecases, sometimes you need to setup other things on the machine
# You need to provide default values for installation parameters ... # prior to installing the app (such as installing another app)
# EXCEPT for special args: domain, path, admin, and is_public # (Remove this key entirely if not needed)
# which will be filled automatically during tests preinstall = """
language="fr" sudo yunohost app install foobar
password="password" sudo yunohost user list
port="666" """
; Checks
pkg_linter=1 # -------------------------------
setup_sub_dir=1 # Default args to use for install
setup_root=1 # -------------------------------
setup_nourl=0
setup_private=1 # By default, the CI will automagically fill the 'standard' args
upgrade=1 # such as domain, path, admin, is_public and password with relevant values
upgrade=1 from_commit=65c382d138596fcb32b4c97c39398815a1dcd4e8 # and also install args with a "default" provided in the manifest..
backup_restore=1 # It should only make sense to declare custom args here for args with no default values
multi_instance=1
port_already_use=1 (66) args.language = "fr_FR" # NB : you should NOT need those lines unless for custom questions with no obvious/default value
change_url=0 args.multisite = 0
;;; Upgrade options
; commit=65c382d138596fcb32b4c97c39398815a1dcd4e8 # -------------------------------
name=Name of this previous version # Commits to test upgrade from
manifest_arg=domain=DOMAIN&path=PATH&admin=USER&password=pass&is_public=1& # -------------------------------
test_upgrade_from.00a1a6e7.name = "Upgrade from 5.4"
test_upgrade_from.00a1a6e7.args.foo = "bar"
# This is an additional test suite
[multisite]
# On additional tests suites, you can decide to run only specific tests
only = ["install.subdir"]
args.language = "en_GB"
args.multisite = 1
``` ```
### `;; Default test serie` Note that you can run `python3 lib/parse_tests_toml.py /path/to/your/app/ | jq` to dump what tests will be run by package check
A name for the series of tests to perform.
It's possible to create multiple tests series, all with the same syntax.
All different series will be performed sequentially.
### `; pre-install`
_Optional instruction_
If you have to execute a command or a group of commands before the installation. You can use this instruction.
All the commands added after the instruction `; pre-install` will be executed in the container before each installation of the app.
### `; Manifest`
List of manifest keys.
All manifest keys need to be filled to perform the installation.
> The manifest keys already in the file here are simply examples. Check the package manifest.
### `; Checks`
List of tests to perform.
Each test set to 1 will be performed by the script.
If a test is not in the list, it will be ignored. It's similar to set the test at 0.
- `pkg_linter`: Check the package with [package linter](https://github.com/YunoHost/package_linter)
- `setup_root`: Installation at the root of a domain.
- `setup_sub_dir`: Installation in a path.
- `setup_nourl`: Installation with no domain/path. This test is meant for non-web apps
- `setup_private`: Private installation.
- `upgrade`: Upgrade the package to the same version. Only to test the upgrade script.
- `upgrade from_commit`: Upgrade the package from the specified commit to the latest version.
- `backup_restore`: Backup then restore.
- `multi_instance`: Install the application 2 times, to verify its ability to be multi-instanced.
- `port_already_use`: Provoke an error by opening the port before.
The `port_already_use` test may eventually take as argument the port number.
The port number must be written into parentheses.
- `change_url`: Try to change the url by 6 different ways. Root to path, path to another path and path to root. And the same thing, to another domain.
### `;;; Upgrade options`
_Optional instruction_
For each specified commit for an upgrade, allow to give a name for this version and the manifest parameters which will be used for the preliminary installation.
If there's no name specified, the commit will be used.
And if there's no manifest arguments, the default arguments of the check process will be used.
> 3 variables have to be used for the arguments of the manifest, DOMAIN, PATH and USER.
---
The `package_check.sh` script accept 6 arguments in addition of the package to be checked.
- `--branch=branch-name`: Check a branch of the repository instead of master. Allow to check a pull request.
You can use an url with a branch, https://github.com/YunoHost-Apps/APP_ynh/tree/my_branch, to implicitly use this argument.
- `--interactive`: Wait for user input between each tests
- `--help`: Display help.

10
lib/parse_tests_toml.py
View file

@ -23,8 +23,8 @@ def generate_test_list_base(test_manifest, default_install_args, is_webapp, is_m
install_args.update(test_suite.get("args", {})) install_args.update(test_suite.get("args", {}))
default_meta = { default_meta = {
"preinstall_template": test_suite.get("preinstall_template", ""), "preinstall": test_suite.get("preinstall", ""),
"preupgrade_template": test_suite.get("preupgrade_template", ""), "preupgrade": test_suite.get("preupgrade", ""),
"install_args": install_args, "install_args": install_args,
} }
@ -111,10 +111,10 @@ def dump_for_package_check(test_list, package_check_tests_dir):
"test_serie": test_suite_id, "test_serie": test_suite_id,
"test_type": "TEST_" + test_type.upper(), "test_type": "TEST_" + test_type.upper(),
"test_arg": test_arg, "test_arg": test_arg,
"preinstall_template": meta.pop("preinstall_template", ""), "preinstall_template": meta.pop("preinstall", ""),
"preupgrade_template": meta.pop("preupgrade_template", ""), "preupgrade_template": meta.pop("preupgrade", ""),
"install_args": '&'.join([k + "=" + str(v) for k, v in meta.pop("install_args").items()]), "install_args": '&'.join([k + "=" + str(v) for k, v in meta.pop("install_args").items()]),
"extra": meta # Boring logic just to ship the upgrade-from-commit's name ... "extra": meta # Boring legacy logic just to ship the upgrade-from-commit's name ...
} }
test_file_id = test_suite_i * 100 + subtest_i test_file_id = test_suite_i * 100 + subtest_i