build.sh

#!/bin/sh
#
# BSD 2-Clause License
#
# Copyright (c) 2024. Carlo Strub <cs@carlostrub.ch>
#
#  Redistribution and use in source and binary forms, with or without
#  modification, are permitted provided that the following conditions are met:
#
#  1. Redistributions of source code must retain the above copyright notice, this
#     list of conditions and the following disclaimer.
#
#  2. Redistributions in binary form must reproduce the above copyright notice,
#     this list of conditions and the following disclaimer in the documentation
#     and/or other materials provided with the distribution.
#
#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
#  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
#  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
#  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
#  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
#  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
#  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
#  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#

# This script is used to build and test the project. If you pass the coveralls
# token, it will also upload the coverage report to coveralls.io.
#
# Usage:
#  build.sh --coveralls <coveralls_token>
#

# Static Code Analysis
echo "Running static code analysis..."
cargo fmt --all -- --check
cargo clippy --all-targets --all-features -- -D warnings

# Building the project
echo "Building project..."
cargo build -v

# Running tests
echo "Running tests..."
cargo test -v --no-fail-fast

# Create documentation
echo "Create the documentation..."
cargo doc --document-private-items --no-deps;
rm -r /usr/local/www/backgammon/doc/backgammon;
cp -r target/doc/backgammon /usr/local/www/backgammon/doc/backgammon;

# Create README
echo "Create README.md"
cargo readme > README.md

# Checking coverage
echo "Checking coverage..."
if [ -z "$2" ]
then
    echo "No coveralls token provided. Skipping upload."
    cargo tarpaulin
else
    echo "Uploading coverage report to coveralls.io..."
    cargo tarpaulin --coveralls "$2"
fi


# Checking audit reports
echo "Checking audit reports..."
cargo-audit audit