#!/bin/bash

# Copyright (C) 2012, Benjamin Drung <bdrung@debian.org>
#            ©  2017  Mattia Rizzolo <mattia@debian.org>
#
# Permission to use, copy, modify, and/or distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

set -u

if test "${1:-}" = --installed; then
    COMMAND="dch --no-conf"
    shift
else
    COMMAND="perl -I ${0%/*}/../lib ${0%/*}/../scripts/debchange.pl --no-conf"
fi

. "${0%/*}/shunit2-helper-functions.sh"

setUp() {
    CHANGELOG="${SHUNIT_TMPDIR}/changelog"
    DEBFULLNAME="Raphaël Hertzog"
    DEBEMAIL="hertzog@debian.org"
    unset UBUMAIL
    export DEBFULLNAME DEBEMAIL
}

tearDown() {
    unset CHANGELOG DEBFULLNAME DEBEMAIL
}

runCommand2() {
    local param="$1"
    local exp_stdout="$2"
    local exp_stderr="$3"
    local exp_retval=$4
    local stdoutF="${SHUNIT_TMPDIR}/stdout"
    local stderrF="${SHUNIT_TMPDIR}/stderr"
    eval "${COMMAND} $param" > ${stdoutF} 2> ${stderrF}
    # Strip distribution data outdated warnings (caused by outdate distro-info-data).
    cat $stderrF | \
        grep -v "^Distribution data outdated. Please check for an update for distro-info-data. See /usr/share/doc/distro-info-data/README.Debian for details." | \
        grep -v '^debchange[^ ]* warning: Unable to determine the current Ubuntu development release. Using UNRELEASED instead.$' > ${stderrF}.tmp
    mv ${stderrF}.tmp ${stderrF}
    retval=$?
    assertEquals "standard output of ${COMMAND} $param\n" "$exp_stdout" "$(cat ${stdoutF})"
    assertEquals "error output of ${COMMAND} $param\n" "$exp_stderr" "$(cat ${stderrF})"
    assertEquals "return value of ${COMMAND} $param\n" $exp_retval $retval
}

success() {
    runCommand2 "-c \"$CHANGELOG\" $1" "" "" 0
}

runCommand3() {
    local param="$1"
    local exp_stdout="$2"
    local exp_stderr="$3"
    local exp_retval=$4
    local stdoutF="${SHUNIT_TMPDIR}/stdout"
    local stderrF="${SHUNIT_TMPDIR}/stderr"
    eval "${COMMAND} $param" > ${stdoutF} 2> ${stderrF}
    # Strip distribution data outdated warnings (caused by outdate distro-info-data).
    cat $stderrF | \
        grep -v "^Distribution data outdated. Please check for an update for distro-info-data. See /usr/share/doc/distro-info-data/README.Debian for details." | \
        grep -v '^debchange[^ ]* warning: Unable to determine the current Ubuntu development release. Using UNRELEASED instead.$' > ${stderrF}.tmp
    mv ${stderrF}.tmp ${stderrF}
    retval=$?
    assertContains "error output of ${COMMAND} $param\n" "$(cat ${stderrF})" "$exp_stderr"
}

failure() {
    runCommand3 "-c \"$CHANGELOG\" $1" "" "$2" 0
}

checkUbuntuDevelAvailable() {
    if ubuntu-distro-info --devel 2>/dev/null >&2; then
        # distro-info-data knows of the current devel release
        true
    else
        # distro-info-data doesn't know of the current devel release
        false
    fi
}

checkVersion() {
    local start_param="$1"
    local param="$2"
    local start_version="$3"
    local expected_version="$4"
    rm -f "$CHANGELOG"
    success "--create $start_param --package test-package -v $start_version \"Devscripts Test Suite.\""
    success "$param \"Version test.\""
    local version=$(dpkg-parsechangelog -l"$CHANGELOG" -SVersion)
    assertEquals "\"dch $param\" from version $start_version" "$expected_version" "$version"
}

checkDebianDistribution() {
    checkVersion "--vendor Debian -D unstable" "--vendor Debian -i -D $1" "1.0-1" "1.0-2"
}

checkDebianVersion() {
    checkVersion "--vendor Debian -D unstable" "--vendor Debian $1" "$2" "$3"
}

checkUbuntuVersion() {
    checkVersion "--vendor Debian -D unstable" "--vendor Ubuntu $1" "$2" "$3"
}

testDebianDistributions() {
    checkDebianDistribution "forky"
    checkDebianDistribution "forky-security"
    checkDebianDistribution "trixie"
    checkDebianDistribution "trixie-proposed-updates"
    checkDebianDistribution "trixie-security"
    checkDebianDistribution "bookworm"
    checkDebianDistribution "bookworm-proposed-updates"
    checkDebianDistribution "bookworm-security"
    checkDebianDistribution "bullseye"
    checkDebianDistribution "bullseye-security"
    checkDebianDistribution "buster"
    checkDebianDistribution "buster-security"
    checkDebianDistribution "experimental"
    checkDebianDistribution "oldstable"
    checkDebianDistribution "oldstable-proposed-updates"
    checkDebianDistribution "oldoldstable"
    checkDebianDistribution "oldoldstable-proposed-updates"
    checkDebianDistribution "proposed-updates"
    checkDebianDistribution "stable"
    checkDebianDistribution "stable-proposed-updates"
    checkDebianDistribution "testing"
    checkDebianDistribution "testing-proposed-updates"
    checkDebianDistribution "UNRELEASED"
}

testDebianIncrement() {
    checkDebianVersion "-i" "1.0-1" "1.0-2"
    checkDebianVersion "-i" "12" "13"
}

testUbuntuIncrement() {
    if ! checkUbuntuDevelAvailable; then
        echo "No known Ubuntu devel release known, skipping related tests"
        startSkipping
    fi
    checkUbuntuVersion "-i" "12" "12ubuntu1"
    checkUbuntuVersion "-i" "3.4" "3.4ubuntu1"
    checkUbuntuVersion "-i" "3.4.5" "3.4.5ubuntu1"
    checkUbuntuVersion "-i" "5.6-7" "5.6-7ubuntu1"
    checkUbuntuVersion "-i" "5.6-7.1" "5.6-7.1ubuntu1"
    checkUbuntuVersion "-i" "5.6-7.1.8" "5.6-7.1.8ubuntu1"
    checkUbuntuVersion "-i" "2.13-14build5" "2.13-14ubuntu1"
    checkUbuntuVersion "-i" "0.45-2ubuntu3" "0.45-2ubuntu4"
    checkUbuntuVersion "-i" "0.45-2ubuntu3.1" "0.45-2ubuntu3.2"
    checkUbuntuVersion "-i" "0.45-2ubuntu3.1.0" "0.45-2ubuntu3.1.1"
    checkUbuntuVersion "-i" "1ubuntu" "2ubuntu"
    checkUbuntuVersion "-i" "1.2ubuntu" "1.3ubuntu"
    checkUbuntuVersion "-i" "3.1.2ubuntubuild10" "3.1.3ubuntu"
    checkUbuntuVersion "-i" "3.1.2ubuntu.build10" "3.1.3ubuntu"
}

testUbuntuRebuild() {
    if ! checkUbuntuDevelAvailable; then
        echo "No known Ubuntu devel release known, skipping related tests"
        startSkipping
    fi
    checkUbuntuVersion "-R" "3.4" "3.4build1"
    checkUbuntuVersion "-R" "2.0-4" "2.0-4build1"
    checkUbuntuVersion "-R" "1.42-4ubuntu5" "1.42-4ubuntu6"
    checkUbuntuVersion "-R" "0.1-2build3" "0.1-2build4"
    checkUbuntuVersion "-R" "0.1ubuntu" "0.1ubuntu.build1"
    checkUbuntuVersion "-R" "0.2ubuntu.build1" "0.2ubuntu.build2"
}

verifyMaintainer() {
    local maintainer="$(dpkg-parsechangelog -l"$CHANGELOG" -SMaintainer)"
    assertEquals "\"$1\"" "$DEBFULLNAME <$DEBEMAIL>" "$maintainer"
}

testEncoding() {
    rm -f "$CHANGELOG"
    success "--create -D unstable --package test-package -v 1.0-1 \"First upload\""
    verifyMaintainer "dch --create"

    success "-a \"Some change\""
    verifyMaintainer "dch -a"

    success "-i \"Second upload\""
    verifyMaintainer "dch -i"

    success "-e \"Another change\""
    verifyMaintainer "dch -e"

    success "-n NMU"
    verifyMaintainer "dch -n"

    success "-v 1.1-1 \"New upstream\""
    verifyMaintainer "dch -v"

    success "--bin-nmu \"Rebuild against libfoo\""
    verifyMaintainer "dch --bin-nmu"

    success "-q \"QA upload\""
    verifyMaintainer "dch -q"

    success "-s \"Security upload\""
    verifyMaintainer "dch -s"

    success "-s \"LTS Security upload\""
    verifyMaintainer "dch --lts"

    success "--sloppy \"Backports upload\""
    verifyMaintainer "dch --sloppy"

    success "--bpo \"Backports upload\""
    verifyMaintainer "dch --bpo"

    success "--stable \"Stable upload\""
    verifyMaintainer "dch --stable"
}

verifyEntryLines() {
    success "--vendor Debian $1"
    local changes="$(dpkg-parsechangelog -l"$CHANGELOG" -SChanges | grep -F '*')"
    assertEquals "\"$changes\"" 1 "$(echo "$changes" | wc -l)"
}

# Any options which automatically add their own entry to the changelog should
# elide an empty entry if the user passes an empty string as the entry.
testEmptyMessage() {
    rm -f "$CHANGELOG"
    success "--create -D unstable --package test-package -v 1.0-1 'First upload'"

    verifyEntryLines "--nmu ''"

    verifyEntryLines "--bin-nmu ''"

    verifyEntryLines "--qa ''"

    verifyEntryLines "--security ''"

    verifyEntryLines "--sloppy ''"

    verifyEntryLines "--bpo ''"

    verifyEntryLines "--team ''"
}

verifyGuessedDistribution() {
    # $1 → initial suite
    # $2 → action
    # $3 → expected suite after the action
    rm -f "$CHANGELOG"
    vdeb="--vendor Debian"
    success "$vdeb --create -D $1 --package test-package -v 1.0-1 'First upload'"
    success "$vdeb $2 'Second Upload'"
    success "$vdeb -r ''"
    local dist="$(dpkg-parsechangelog -l"$CHANGELOG" -SDistribution)"
    assertEquals "$3" "$dist"
}

testGuessedDistribution() {
    verifyGuessedDistribution unstable -i unstable
    verifyGuessedDistribution experimental -i experimental
    verifyGuessedDistribution trixie-backports -i trixie-backports
    verifyGuessedDistribution trixie -i trixie
    verifyGuessedDistribution unstable --sloppy bookworm-backports-sloppy
    verifyGuessedDistribution unstable --bpo trixie-backports
    verifyGuessedDistribution unstable --stable trixie
}

testSpecialCharacterMaintainer() {
    rm -f "$CHANGELOG"
    export DEBFULLNAME='\k'
    success "--create -D unstable --package test-package -v 1.0-1 \"First upload\""
    success "-a \"Some change\""
}

testCustomDate() {
    custom_date="Tue, 23 Jun 2023 12:34:56 +0530"
    rm -f "$CHANGELOG"
    success "--create -D unstable --package test-package -v 1.0-1 \"First upload\""
    success "-i \"Second upload\" --date \"$custom_date\""
    entry_date=$(dpkg-parsechangelog -l"$CHANGELOG" -SDate)
    assertEquals "Changelog entry date" "$custom_date" "$entry_date"
}

testInvalidCustomDate() {
    invalid_custom_date="Tue, 23 Jun 20234 12:34:56 +0530"
    failure "-i \"Third upload\" --date \"$invalid_custom_date\"" \
      "Date 'Tue, 23 Jun 20234 12:34:56 +0530' is not in RFC 5322 format. Example:"
}

. shunit2
