Binbash

.github/workflows/integration_tests.yml

@@ -0,0 +1,36 @@
+name: Integration tests
+on:
+  [push, pull_request]
+
+jobs:
+  initialize-repository:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+  integration-tests:
+    needs: initialize-repository
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Update the system
+        run: sudo apt update -y
+
+      - name: Install dependencies
+        run: |
+          sudo apt install -y shunit2 podman
+
+      - name: Integration tests
+        run: ./run_tests.sh --integration

.github/workflows/kcov.yml

@@ -10,7 +10,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 3
 
@@ -37,7 +37,7 @@ jobs:
         run: |
           kcov --include-path=src,kw \
           --exclude-pattern=src/bash_autocomplete.sh,src/help.sh \
-          kcov_out/ ./run_tests.sh
+          kcov_out/ ./run_tests.sh --unit
 
       - name: Upload coverage do codecov
         run: |

.github/workflows/shellcheck_reviewdog.yml

@@ -6,7 +6,7 @@ jobs:
     name: runner / shellcheck
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: shellcheck
         uses: reviewdog/action-shellcheck@v1
         with:

.github/workflows/shfmt.yml

@@ -5,7 +5,7 @@ jobs:
   sh-checker:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Run the sh-checker
         uses: luizm/[email protected]
         env:

.github/workflows/test_setup_and_docs.yml

@@ -10,7 +10,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # This is here just because git-email cannot be installed in the 
       # Github CI otherwise.

.github/workflows/unit_tests.yml

@@ -10,7 +10,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 3
 
@@ -30,4 +30,4 @@ jobs:
 
       - name: Unit tests
         run: |
-          ./run_tests.sh
+          ./run_tests.sh --unit

database/migrate_legacy_data_20220101.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # This file handles the migration of legacy user data, from the old directories and files
 # storage, to the new database model

documentation/conf.py

@@ -177,7 +177,6 @@
     ('man/features/kw-pomodoro', 'kw-pomodoro', 'pomodoro style time management', [author], 1),
     ('man/features/kw-report', 'kw-report', 'user data report support', [author], 1),
     ('man/features/kw-ssh', 'kw-ssh', 'ssh access', [author], 1),
-    ('man/features/kw-vars', 'kw-vars', 'view kw config values', [author], 1),
     ('man/features/kw-vm', 'kw-vm', 'commands to work with QEMU VMs', [author], 1),
     ('man/features/kw-self-update', 'kw-self-update', 'kw self-update mechanism', ['David Tadokoro, Everaldo Junior'], 1),
     ('man/features/kw-patch-hub', 'kw-patch-hub', 'UI with lore.kernel.org archives', ['David Tadokoro, Rodrigo Siqueira'], 1),

documentation/content/codingstyle.rst

@@ -317,6 +317,12 @@ Good::
 
   rsync --verbose --recursive dir1 dir2
 
+Declaring shebangs
+------------------
+
+Avoid using "#!/bin/bash" when writing new bash files. This usual shebang may not work for
+some linux distributions that don't follow FHS, such as NixOS. Use "#!/usr/bin/env bash" instead.
+
 Conclusion
 ----------
 

documentation/content/tests.rst

@@ -1,5 +1,5 @@
 ===============
-  About Tests
+About Tests
 ===============
 
 .. _tests:
@@ -9,6 +9,12 @@ Kw's tests rely on `shunit2`. The `run_tests.sh` script automatically detects
 can have shunit2 source code in `tests/` (you can clone it from
 https://github.com/kward/shunit2).
 
+In order to run the integration tests, it is necessary to install Podman and  to
+configure it to run in rootless mode as explained in the official documentation:
+https://github.com/containers/podman/blob/main/docs/tutorials/rootless_tutorial.md.
+Podman is available via the default package manager of popular distros, such  as
+Arch, Debian, Fedora and those based on them.
+
 If you want to run all the tests, try::
 
   ./run_tests.sh
@@ -19,7 +25,43 @@ List all available test files::
 
 Or run individual tests with::
 
-  ./run_tests.sh test TESTFILE1 ...
+  ./run_tests.sh test TEST_FILE_1 ...
+
+To limit the scope of the tests, pass the flag `--unit` or `--integration` as
+the first argument to any of the examples above. So, the syntax is::
+
+  ./run_tests.sh [scope] [command] [args]
+
+Where `[scope]` can be `--unit` or `--integration`. The placeholder  `[command]`
+can be either `list`, `test` or simply omitted in order to run  all  tests. Here
+are some examples:
+
+.. code-block:: bash
+
+  ./run_tests.sh --unit                       # run all unit tests
+  ./run_tests.sh --unit list                  # list all unit tests
+  ./run_tests.sh --unit test device           # test device unit test
+  ./run_tests.sh --unit clear-cache           # clear unit tests cache
+  ./run_tests.sh --integration                # run all integration tests
+  ./run_tests.sh --integration list           # list all integration tests
+  ./run_tests.sh --integration test device    # test device integration test
+  ./run_tests.sh --integration clear-cache    # clear integration tests cache
+  ./run_tests.sh                              # run all tests
+  ./run_tests.sh list                         # list all tests
+  ./run_tests.sh test device                  # run all device tests
+  ./run_tests.sh clear-cache                  # clear all cache
+
+The integration tests can take over 10 minutes to run in the first time  because
+podman is building the container images to be used in the tests, which  requires
+installing kw's dependencies in the supported distros.  After  the  images  have
+been built and cached, running the integration tests  should  take  only  a  few
+seconds each time.
+
+Then, the local kw repo is copied to the containers and installed  again,  which
+takes very few seconds. For optimization purposes,  the  containers  are  reused
+across  tests. If you add a new commit or checkout to another branch, such  that
+HEAD points to another commit, the containers  will  be  destroyed  and  created
+again in order to install the current local version of kw.
 
 Kw is already prepared to run tests, build the documentation and check the
 installation in the github workflow.

documentation/dependencies/arch.dependencies

@@ -26,3 +26,6 @@ curl
 perl-xml-xpath
 coreutils
 b4
+procps-ng
+pciutils
+libnotify

documentation/dependencies/debian.dependencies

@@ -28,3 +28,6 @@ curl
 libxml-xpath-perl
 coreutils
 b4
+procps
+pciutils
+libnotify-bin

documentation/dependencies/fedora.dependencies

@@ -24,3 +24,6 @@ curl
 perl-XML-XPath
 coreutils
 b4
+procps-ng
+pciutils
+libnotify

documentation/man/features/kw-backup.rst

@@ -1,6 +1,6 @@
-=========
-kw-backup
-=========
+=============================================
+kw-backup - Save and restore kw internal data
+=============================================
 
 .. _backup-doc:
 
@@ -45,4 +45,4 @@ save it into /documents/backup, then run::
 To restore a backup, use the `\--restore` option. Suppose you want to restore the
 backup stored in /documents/backup/kw-backup-from-yesterday.tar.gz, run::
 
-  kw backup --restore /documents/backup/kw-backup-from-yesterday.tar.gz
+  kw backup --restore /documents/backup/kw-backup-from-yesterday.tar.gz

documentation/man/features/kw-build.rst

@@ -1,6 +1,6 @@
-========
-kw-build
-========
+=======================
+kw-build - Build kernel
+=======================
 
 .. _build-doc:
 
@@ -157,4 +157,4 @@ If you want to reset the kernel tree to its default, `all config and script outp
 
 If you want to use cflags::
 
-  kw b --cflags "-O3 -pipe -march=native"
+  kw b --cflags "-O3 -pipe -march=native"

documentation/man/features/kw-codestyle.rst

@@ -1,12 +1,14 @@
-============
-kw-codestyle
-============
+=================================
+kw-codestyle - Checkpatch wrapper
+=================================
 
 .. _codestyle-doc:
 
 SYNOPSIS
 ========
-*kw* (*c* | *codestyle*) [<directory> | <file> | <patch>]
+| *kw* (*c* | *codestyle*)
+| *kw* (*c* | *codestyle*) [<directory> | <file> | <patch>]
+| *kw* (*c* | *codestyle*) [\--verbose] [<directory> | <file> | <patch>]
 
 DESCRIPTION
 ===========
@@ -22,6 +24,9 @@ OPTIONS
   Define which files to run checkpatch on. Defaults to current working
   directory if it is a kernel tree.
 
+\--verbose:
+  Display commands executed under the hood.
+
 EXAMPLES
 ========
 For these examples, we suppose the fields in your **kworkflow.config** file are

documentation/man/features/kw-config.rst

@@ -1,6 +1,6 @@
-=========
-kw-config
-=========
+=========================================
+kw-config - Manage kw configuration files
+=========================================
 
 .. _config-doc:
 

documentation/man/features/kw-debug.rst

@@ -1,6 +1,6 @@
-========
-kw-debug
-========
+=======================
+kw-debug - Kernel debug
+=======================
 
 .. _debug-doc:
 
@@ -12,6 +12,7 @@ SYNOPSIS
 | *kw* *debug* [(-l | \--list)[=(<ftrace> | <events>)]] [(-e | \--event)]
 | *kw* *debug* [\--reset]
 | *kw* *debug* [(-h | \--help)]
+| *kw* *debug* [(\--verbose)]
 
 DESCRIPTION
 ===========
@@ -123,6 +124,11 @@ OPTIONS
   `\--dmesg`, kw will (1) clean the dmesg log, (2) run the command, (3) and
   collect the log.
 
+\--verbose:
+  Verbose mode is an option that causes the kw program to display debug
+  messages to track its steps. This functionality is very useful during the
+  debugging process, allowing you to identify possible errors more easily.
+
 EXAMPLES
 ========
 

documentation/man/features/kw-deploy.rst

@@ -1,6 +1,6 @@
-=========
-kw-deploy
-=========
+=========================
+kw-deploy - Deploy kernel
+=========================
 
 .. _deploy-doc:
 

documentation/man/features/kw-device.rst

@@ -1,6 +1,6 @@
-=========
-kw-device
-=========
+=========================================
+kw-device - Retrieve hardware information
+=========================================
 
 .. _device-doc:
 

documentation/man/features/kw-diff.rst

@@ -1,6 +1,6 @@
-=======
-kw-diff
-=======
+===================
+kw-diff - Diff tool
+===================
 
 .. _diff-doc:
 
@@ -22,4 +22,4 @@ OPTIONS
 \--verbose:
   Verbose mode is an option that causes the kw program to display debug messages to track
   its progress. This functionality is very useful during the debugging process, allowing
-  you to identify possible errors more easily.
+  you to identify possible errors more easily.

documentation/man/features/kw-drm.rst

@@ -1,6 +1,6 @@
-======
-kw-drm
-======
+============================
+kw-drm - DRM subsystem tools
+============================
 
 .. _drm-doc:
 

documentation/man/features/kw-env.rst

@@ -1,6 +1,6 @@
-======
-kw-env
-======
+===============================
+kw-env - kw environment manager
+===============================
 
 .. _env-doc:
 

documentation/man/features/kw-explore.rst

@@ -1,6 +1,6 @@
-==========
-kw-explore
-==========
+===========================
+kw-explore - Explore folder
+===========================
 
 .. _explore-doc:
 

documentation/man/features/kw-init.rst

@@ -1,6 +1,6 @@
-=======
-kw-init
-=======
+======================================
+kw-init - Create kw basic config files
+======================================
 
 .. _init-doc:
 

documentation/man/features/kw-kernel-config-manager.rst

@@ -1,6 +1,6 @@
-========================
-kw-kernel-config-manager
-========================
+=====================================================
+kw-kernel-config-manager - Kernel config file manager
+=====================================================
 
 .. _kernel-config-manager-doc: