Added GitHub Actions CI

[tdulcet]

Edit: This PR is now very outdated, but I would be happy to update it if there is ever interest in adding CI. Travis CI is no longer free, so we would need to use GitHub Actions CI instead.

• Added GitHub Actions CI (continuous integration).
  • Tests on Ubuntu 22.04.
  • Runs the ShellCheck linter. Bugs fixed in Fixed bugs found by the ShellCheck linter #1457.
  • Run the Ruff Python linter. Some errors fixed in Fixed errors found by the Ruff Python linter #2343.
    • Config file added in Added config file for the Ruff Python linter and fixed additional errors #2473.
  • Ready to run the starting a test suite (#777) #1039 test suite, once it is merged. Just uncomment the three lines.

This pull request was originally part of #1435.

[JoshData]

Great.

Can you explain what's going on in some of the steps? It would be good to add some comments to the .travis.yml file. Also why the change to certbot?

[tdulcet]

Can you explain what's going on in some of the steps?

mailinabox/.travis.yml

Line 13 in 4f64f51

- sudo sed -i "s/^127.0.1.1.*/127.0.1.1\t$HOSTNAME.example.com\t$HOSTNAME/" /etc/hosts

Adds a hostname to the hosts file.

mailinabox/.travis.yml

Lines 14 to 15 in 4f64f51

	- sudo apt-get -yqq update
	- sudo apt-get -yqq dist-upgrade

Updates the apt package database and upgrades all currently installed packages. This is of course already done as part of the script, but doing it here significantly reduces the script runtime and makes sure Ubuntu and all the commands used by the script before it does the upgrade, are up to date.

mailinabox/.travis.yml

Line 16 in 4f64f51

- sudo rm -f /opt/jdk_switcher/jdk_switcher.sh

Fixes a temporary issue with Travis CI and SpamAssassin. See here: travis-ci/travis-ci#8906 (comment).

mailinabox/.travis.yml

Line 19 in 4f64f51

- sudo setup/start.sh

Runs the script.

mailinabox/.travis.yml

Lines 20 to 23 in 4f64f51

	- curl -IkL "https://$HOSTNAME/"
	- curl -IkL "https://$HOSTNAME/admin"
	- curl -IkL "https://$HOSTNAME/mail/"
	- curl -IkL "https://$HOSTNAME/cloud/"

Verifies that all the services are running by getting the HTTP headers. You can check for the 200 OK HTTP status code.

mailinabox/.travis.yml

Line 24 in 4f64f51

- bash -c 'shopt -s globstar; shellcheck -s bash **/*.sh || true'

Runs ShellCheck. See here. #1457 fixes most of the bugs that are found. This line allows contributors to verify that new bugs are not added in future commits.

You can see the output of all these commands in the log here.

It would be good to add some comments to the .travis.yml file.

I can add the above as comments the .travis.yml file, if you would like.

Also why the change to certbot?

I was having issues with the script hanging on the certbot command in Travis CI.

mailinabox/setup/start.sh

Line 144 in 4f64f51

certbot register -n --register-unsafely-without-email --agree-tos --config-dir $STORAGE_ROOT/ssl/lets_encrypt

This change forces certbot to run non-interactively. See here.

mailinabox/setup/management.sh

Line 32 in 4f64f51

apt_install duplicity python-pip python-virtualenv certbot python-certbot-nginx

This change makes sure that all the required python dependencies are installed.

[tdulcet]

@JoshData Comments added to the .travis.yml file in cfcf34b.

[tdulcet]

@JoshData - Now that Travis CI is no longer free, I updated this PR to use GitHub Actions CI and test on Ubuntu 22.04. I also added comments to the workflow file as requested.