Skip to content

Complete refactoring for start-mailserver.sh #1605

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
georglauterbach merged 4 commits into from
Sep 23, 2020
Merged

Complete refactoring for start-mailserver.sh #1605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7f64ab6
completely refactored `start-mailserver.sh`
Sep 8, 2020
f672113
added braces; correctly formatted tabs / spaces
Sep 10, 2020
91f3d74
Merge branch 'master' into start_mailserver
georglauterbach Sep 10, 2020
1727bd6
cleanup
Sep 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ The development workflow is the following:

### Bash and Shell

When refactoring, writing or altering Script, that is Shell and Bash scripts, in any way, adhere to these rules:
When refactoring, writing or altering scripts, that is Shell and Bash scripts, in any way, adhere to these rules:

1. **Adjust your style of coding to the style that is already present**! Even if you do not like it, this is due to consistency. Look up the GNU coding style guide. There was a lot of work involved in making these scripts consistent.
2. **Use `shellcheck` to check your scripts**! Your contributions are checked by TravisCI with shellcheck.
2. **Use `shellcheck` to check your scripts**! Your contributions are checked by TravisCI with shellcheck. You can check your scripts like Travis with `make shellcheck`.
3. There is a **`.editorconfig`** file. Make your IDE use it or adhere to it manually!
4. It's okay to use `/bin/bash` instead of `/bin/sh`. You can alternatively use `/usr/bin/env bash`.
5. `setup.sh` provides a good starting point to look for.
Expand Down Expand Up @@ -84,15 +84,15 @@ When writing a script, provide the version and the script's task. We use [semant
if [[ <CONDITION1> ]] && [[ -f ${FILE} ]]
then
<CODE TO RUN>
# when running code, you don't need them
# when running commands, you don't need braces
elif <COMMAND TO RUN>
<CODE TO TUN>
else
<CODE TO TUN>
fi

# equality checks with numbers, use
# -eq/-ne/-lt/-ge, not != or ==
# equality checks with numbers are done
# with -eq/-ne/-lt/-ge, not != or ==
if [[ $VAR -ne 42 ]] || [[ $SOME_VAR -eq 6 ]]
then
<CODE TO RUN>
Expand Down Expand Up @@ -133,7 +133,7 @@ function _<name_underscored_and_lowercase>()
<CODE TO RUN>

# variables that can be local should be local
local _<LOCAL_VARIABLE_NAME>
local <LOCAL_VARIABLE_NAME>
}
```

Expand All @@ -157,6 +157,16 @@ function _report_err()

Comments should only describe non-obvious matters. Comments should start lowercase when they aren't sentences. Make the code **self-descriptive** by using meaningful names! Make comments not longer than approximately 80 columns, then wrap the line.

A positive example:

``` BASH
# writes result to stdout
function _add_one()
{
echo $(( $1 + 1 ))
}
```

A negative example:

``` BASH
Expand All @@ -167,31 +177,21 @@ function _add_one()
local FIRST=$1

# add one here
local RESULT=$(( _FIRST + 1 ))
local RESULT=$(( FIRST + 1 ))

# print it to stdout
echo "$_RESULT"
}
```

A positive example:

``` BASH
# writes result to stdout
function _add_one()
{
echo $(( $1 + 1 ))
}
```

### YAML

When formatting YAML files, you can opt for [Prettier][prettier]. There are any plugins for IDEs around.
When formatting YAML files, you can opt for [Prettier][prettier]. There are many plugins for IDEs around.

[//]: # (Links)

[commit]: https://help.github.com/articles/closing-issues-via-commit-messages/
[gpg]: https://docs.github.com/en/github/authenticating-to-github/generating-a-new-gpg-key
[semver]: https://semver.org/
[regex]: https://regex101.com/r/ikzJpF/4
[regex]: https://regex101.com/r/ikzJpF/5
[prettier]: https://prettier.io
4 changes: 1 addition & 3 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,11 +167,9 @@ shellcheck:
@ echo -e "Testing shell / bash scripts with shellcheck\n"
@ /usr/bin/shellcheck --version
@ echo ''
# currently without `start-mailserver` as this is to be merged separately
@ if find -iname "*.sh" -not -path "./test/*" -not -path "./target/docker-configomat/*" -not -wholename ./target/start-mailserver.sh -exec /usr/bin/shellcheck -S style -Cauto -o all -e SC2250,SC2154 -W 50 {} \; | grep .; then\
@ if find -iname "*.sh" -not -path "./test/*" -not -path "./target/docker-configomat/*" -exec /usr/bin/shellcheck -S style -Cauto -o all -e SC2154 -W 50 {} \; | grep .; then\
echo -e "\nError" ;\
exit 1 ;\
else\
echo -e '\nSuccess' ;\
fi

7 changes: 4 additions & 3 deletions target/dovecot/scripts/quota-warning.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

# Report a quota usage warning to an user

PERCENT=$1
USER=$2
DOMAIN=$3
PERCENT="${1}"
USER="${2}"
DOMAIN="${3}"

# shellcheck disable=SC2250
cat << EOF | /usr/lib/dovecot/dovecot-lda -d "$USER" -o "plugin/quota=maildir:User quota:noenforcing"
From: postmaster@$DOMAIN
Subject: quota warning
Expand Down
Loading