/kworkflow

This set of scripts have a simple mission: reduce the overhead with infrastructure setup for Linux development

Primary LanguageShellGNU General Public License v2.0GPL-2.0

Kworkflow

About

This set of scripts have a simple mission: reduce the overhead with infrastructure setup for Linux development. We export all the scripts functionality via bashrc, to make the commands available in any place you want to work.

Kworkflow stands for Kernel Workflow.

Package Dependencies

You have to figure out the correct package name in your distro for the following dependencies:

  • libguestfs
  • Qemu
  • Ansible
  • Bash
  • git

If you want to use the default alert system (for commands that may take longer to run), you will also need to install:

  • paplay
  • notify-send

For development, you will need the additional packages:

  • dash
  • shunit2

Recommendations

If you want to use Qemu, we recommend the following steps:

  1. Create a Qemu image in the qcow2 format;
  2. Create a working directory: /mnt/qemu;
  3. After you have your image, we recommend you to setup basic stuff (this can vary depending on the distribution you choose - kernel setup, ssh, etc);

Install kw

In the main directory, type:

./setup.sh -i
bash --login

This command will install kw in ~/.config/kw, and add the following lines at the end of your .bashrc:

# kw
PATH=$PATH:/home/<user>/.config/kw
source /home/<user>/.config/kw/src/bash_autocomplete.sh

If you use another shell (ksh, for example), you will need to manually add the path to kw to PATH environment variable.

To check if the installations was ok, type:

kw help

Finally, everytime that you want to update your kw, just pull from this repository and install again (./setup -i removes legacy files and installs new ones).

Global configuration file

All the default configurations used by kworflow can be seen at "~/.config/kw/etc/kworkflow.config"; this config file has a comment on each configuration option. Finally, it is important to highlight that kw loads the default configurations; next, it tries to find a local configuration file (detailed ahead) and overwrites the global options with the ones read from the local config file.

Local configuration file

One of the features of this project is the ability to set a specific set of configuration per directory. For example, if you have a particular kernel tree named 'drm-work' and want a different configuration from the default you can follow these steps:

  1. Copy kw.config.example as follows:
cp kworkflow.config.example /path/to/your/kernel/tree/drm-work/kworkflow.config

Note: the default name must be kworkflow.config

  1. Change the options inside:
qemu_hw_options=-enable-kvm -daemonize -m 3G -smp cores=4,cpus=4
qemu_net_options=-net nic -net user,hostfwd=tcp::2222-:22,smb=$HOME
qemu_path_image=$HOME/p/virty.qcow2
  1. Done, every time you execute any command in the root dir of drm-work the configuration file will be read. If the file does not exist, the default operation will be used.

How to

Get help or list existing commands:

kw help|h

Build a Kernel and install it in the Qemu image:

kw bi

Mount the Qemu image to transfer data:

kw mount|mo

Umount the Qemu image:

kw umount|um

Show variable status used by kw:

kw vars|v

Turn on the VM:

kw up|u

Run checkpatch in a target (directory of file):

kw codestyle|c <DIRECTORY_PATH | FILE_PATH>

Get maintainers (directory or file): The option [-a|--authors] will print the file author of FILE_PATH or the authors of the files under DIRECTORY_PATH (non-recursively). Files with more than one author will have their authors separated by ",". Use with care, because sometimes, authors include also "," in their names (e.g. "Company X, Inc.").

kw maintainers|m [-a|--authors] <DIRECTORY_PATH | FILE_PATH>

Search for a regex in a directory or file:

kw explore <EXPRESSION> <DIRECTORY_PATH | FILE_PATH>

Search for a word added in a git commit:

kw explore log <EXRESSION> [-p] <DIRECTORY_PATH | FILE PATH>

You can put your VM in a status that is ready for work with the prepare command. However, there are some basic steps for it to work well:

  1. Add your public key in the VM in the authorized_keys file;
  2. Remove the requirement for password in the VM to became root. Something like that:
user ALL=(ALL) NOPASSWD: ALL

If you have everything set, just execute the command:

kw prepare|p

Some commands take considerable time to execute. So kw gives you an option to be notified when they finish. That way, you can do something else while they run. The commands with this feature available are: prepare, build, install, mount, umount, new and bi. To enable the notification, use the option "--alert=vs", e.g.:

kw prepare --alert=vs

There are four options to --alert=, which are vs|sv, v, s, n.

  • v enables visual notification
  • s enables sound notification
  • vs or sv enables both
  • n (or any other option) disables notifications

The default option, when --alert= is not given is n. It can be configured in the kworflow.config file.

kw configm

The 'configm' option represents the main application that manages the '.config' files for users. In summary, it provides operations for save, load, removes, and list '.config' files previously saved by the user. See the current options:

  • --save NAME [-d DESCRIPTION] [-f] The save option seeks in the current directory for a '.config' file to be to be added under the management of kw. The save option expects a name to be used as a alias for the target config file. If we have a local '.config' and a valid name, kw saves the configuration file. Additionally, users can add a description by using '-d' flag. Finally, if the user tries to add the same name twice kw will warn about it; the '-f' will suppress this message.

  • --ls list all the config files available.

Tests

Tests rely on shunit2. The run_tests.sh automatically uses a shunit2 executable if detected in $PATH (as is the case for package distributions). Otherwise, a shunit2 script is expected to be present in tests/ (downloadable from https://github.com/kward/shunit2).

You can either run all tests with:

run_tests.sh

List all available test files:

run_tests.sh list

Or run individual test files:

run_tests.sh test tfile1 tfile2 tfile3

Tests rely on some external files, that are downloaded automatically when you first try to run a test. You can, however, force run_tests.sh to prepare the environment for running tests, with:

run_tests.sh prepare

Also, if you already have the test's environment prepared but want to update the external files, there's an option to upgrade the environment:

run_tests.sh prepare -f|--force-update

Please note that run_tests.sh must be run from the directory it is in, i.e. the root of the repository. Otherwise, it may not execute properly.

License

Kworkflow is under GPL-2.0+