Reviewdog

.github/workflows/integration_tests.yml

@@ -0,0 +1,23 @@
+name: Integration tests
+on:
+  [push, pull_request]
+
+jobs:
+  integration-tests:
+    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/action-sh-checker@v0.3.0
         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

Dockerfile

@@ -21,5 +21,6 @@ RUN wget https://github.com/koalaman/shellcheck/releases/download/v0.10.0/shellc
     && cp shellcheck-v0.10.0/shellcheck /usr/bin/ \
     && rm -rf shellcheck-v0.10.0
 
-RUN apt install -y shunit2 bc sqlite3 bsdmainutils libxml-xpath-perl 
+RUN apt install -y shunit2 bc sqlite3 bsdmainutils libxml-xpath-perl software-properties-common python3-launchpadlib \
+    python3-venv python3-pip
 #USER kworkflow

Jenkinsfile

@@ -0,0 +1,24 @@
+pipeline {
+  agent any
+  stages {
+
+    stage('Build'){
+      steps{
+        sh '''
+          apt update -y
+          apt install -y kcov shunit2 bc sqlite3 bsdmainutils libxml-xpath-perl
+          ./run_tests.sh prepare
+          mkdir kcov_out/
+          git config --global user.email "kw@kworkflow.net"
+          git config --global user.name "Kworkflow"
+          ./run_tests.sh
+          kcov --include-path=src,kw \
+          --exclude-pattern=src/bash_autocomplete.sh,src/help.sh \
+          kcov_out/ ./run_tests.sh 
+        '''
+        cobertura autoUpdateHealth: false, autoUpdateStability: false, coberturaReportFile: 'kcov_out/', conditionalCoverageTargets: '70, 0, 0', failUnhealthy: false, failUnstable: false, lineCoverageTargets: '80, 0, 0', maxNumberOfBuilds: 0, methodCoverageTargets: '80, 0, 0', onlyStable: false, sourceEncoding: 'ASCII', zoomCoverageChart: false
+      }
+    }
+
+  }
+}

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
@@ -99,7 +99,7 @@ function migrate_statistics()
   cmd_manager 'SILENT' "mv ${datadir}/statistics ${datadir}/legacy_statistics"
   if [[ "$?" != 0 ]]; then
     complain "Couldn't rename ${datadir}/statistics ${datadir}/legacy_statistics"
-    return 1 #EPERM
+    return 1 # EPERM
   fi
 }
 
@@ -161,7 +161,7 @@ function migrate_pomodoro()
   cmd_manager 'SILENT' "mv ${datadir}/pomodoro ${datadir}/legacy_pomodoro"
   if [[ "$?" != 0 ]]; then
     complain "Couldn't rename ${datadir}/pomodoro ${datadir}/legacy_pomodoro"
-    return 1 #EPERM
+    return 1 # EPERM
   fi
 }
 
@@ -216,20 +216,20 @@ function migrate_kernel_configs()
   cmd_manager 'SILENT' "cp -r ${configs_dir}/. ${datadir}/configs"
   if [[ "$?" != 0 ]]; then
     complain "Couldn't copy kernel config files from ${configs_dir} to ${datadir}/configs"
-    return 1 #EPERM
+    return 1 # EPERM
   fi
 
   # mark migrated directories to avoid duplicated data
   cmd_manager 'SILENT' "mv ${datadir}/configs/configs ${datadir}/configs/legacy_configs"
   if [[ "$?" != 0 ]]; then
     complain "Couldn't rename ${datadir}/configs/configs to ${datadir}/configs/legacy_configs"
-    return 1 #EPERM
+    return 1 # EPERM
   fi
 
   cmd_manager 'SILENT' "mv ${datadir}/configs/metadata ${datadir}/configs/legacy_metadata"
   if [[ "$?" != 0 ]]; then
     complain "Couldn't rename ${datadir}/configs/metadata to ${datadir}/configs/legacy_metadata"
-    return 1 #EPERM
+    return 1 # EPERM
   fi
 }
 

documentation/conf.py

@@ -172,15 +172,15 @@
     ('man/features/kw-drm', 'kw-drm', 'drm subsystem support', [author], 1),
     ('man/features/kw-explore', 'kw-explore', 'git grep wrapper', [author], 1),
     ('man/features/kw-init', 'kw-init', 'initialize kworkflow.config', [author], 1),
-    ('man/features/kw-mail', 'kw-mail', 'git send-email wrapper', ['Rubens Gomes Neto'], 1),
+    ('man/features/kw-send-patch', 'kw-send-patch', 'git send-email wrapper', ['Rubens Gomes Neto'], 1),
     ('man/features/kw-maintainers', 'kw-maintainers', 'display module maintainers', [author], 1),
     ('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),
+    ('man/features/kw-bd', 'kw-bd', 'build and then deploy the kernel', ['Briza Mel de Sousa, Lorenzo Salvador'], 1),
 ]
 
 

documentation/content/codingstyle.rst

@@ -244,11 +244,11 @@ a developer. We also encourage using the ``assert_equals_helper`` helper
 function, which provides a wrapper capable of spitting a useful error message
 in case the assertion fails. Ideally, one should do either::
 
-   assert_equals_helper "$error_message" "($LINENO)" "$output" "$expected_output"
+   assert_equals_helper "$error_message" "($LINENO)" "$expected_output" "$output"
 
 or::
 
-   assertEquals "($LINENO)" "$output" "$expected_output"
+   assertEquals "($LINENO)" "$expected_output" "$output"
 
 Help functions
 --------------
@@ -280,6 +280,18 @@ it stays consistent across multiple platforms. If you need to add extra lines
 while generating a string you can use the ``$'\n'`` literal to add a new line
 character or other special characters.
 
+Single quotes instead double quotes
+-----------------------------------
+
+Whenever you have a variable that stands for a string that doesn’t contain 
+shell expansions, use single quotes instead of double quotes. For example::
+
+  var='literal-value' #Single quotes
+
+or::
+
+  path="${HOME}/path/to/file" #Double quotes
+
 String concatenation
 --------------------
 
@@ -317,6 +329,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/project_structure.rst

@@ -44,7 +44,7 @@ Components
 
 We treat every feature under kw as a specific component, usually with a
 dedicated file. For example, the deploy feature implementation can be seen in
-the `src/deploy.sh` file and the mail implementation in the `src/mail.sh` file.
+the `src/deploy.sh` file and the mail implementation in the `src/send_patch.sh` file.
 Usually, the component file follows this basic structure (see :ref:`code-style
 <coding-style>` for more details):
 

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/dependencies/kernel_build/arch.dependencies

@@ -0,0 +1,17 @@
+make
+base-devel
+linux-headers
+bison
+flex
+openssl
+ncurses
+pahole
+xmlto
+kmod
+inetutils
+bc
+libelf
+cpio
+perl
+tar
+xz

documentation/dependencies/kernel_build/debian.dependencies

@@ -0,0 +1,20 @@
+libncurses-dev
+gawk
+flex
+bison
+openssl
+libssl-dev
+dkms
+libelf-dev
+libudev-dev
+libpci-dev
+libiberty-dev
+autoconf
+llvm
+exuberant-ctags
+build-essential
+xmlto
+kmod
+dwarves
+clang
+lld

documentation/dependencies/kernel_build/fedora.dependencies

@@ -0,0 +1,12 @@
+qt3-devel
+libXi-devel
+diffutils
+gcc-c++
+ncurses-devel
+bison
+flex
+openssl-devel
+elfutils-libelf-devel
+openssl
+dwarves
+llvm

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