#!/bin/sh
#
# Copyright (c) 2010 Hudson River Trading LLC
# Written by: John H. Baldwin <jhb@FreeBSD.org>
# All rights reserved.
#
# 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 AUTHOR 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 AUTHOR 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.
#
# $FreeBSD: stable/11/usr.sbin/etcupdate/tests/conflicts_test.sh 281887 2015-04-23 14:22:20Z jhb $

# Various regression tests to run for the 'resolve' command.

setglobal FAILED = 'no'
setglobal WORKDIR = 'work'

proc usage
{
	echo "Usage: conflicts.sh [-s script] [-w workdir]"
	exit 1
}

# Allow the user to specify an alternate work directory or script.
setglobal COMMAND = 'etcupdate'
while getopts "s:w:" option {
	match $option {
		with s
			setglobal COMMAND = ""sh $OPTARG""
			
		with w
			setglobal WORKDIR = $OPTARG
			
		with *
			echo
			usage
			
	}
}
shift $shExpr('OPTIND - 1')
if test $Argc -ne 0 {
	usage
}

setglobal CONFLICTS = "$WORKDIR/conflicts"
setglobal OLD = "$WORKDIR/old"
setglobal NEW = "$WORKDIR/current"
setglobal TEST = "$WORKDIR/test"

# These tests deal with conflicts to a single file.  For each test, we
# generate a conflict in /etc/login.conf.  Each resolve option is tested
# to ensure it DTRT.
proc build_login_conflict
{

	rm -rf $OLD $NEW $TEST $CONFLICTS
	mkdir -p $OLD/etc $NEW/etc $TEST/etc
	
	# Generate a conflict in /etc/login.conf.
	cat > $OLD/etc/login.conf << """
default:'\'
	:passwd_format=md5:
"""
	cat > $NEW/etc/login.conf << """
default:'\'
	:passwd_format=md5:'\'
	:copyright=/etc/COPYRIGHT
"""
	cat > $TEST/etc/login.conf << """
default:'\'
	:passwd_format=md5:'\'
        :welcome=/etc/motd:
"""

	$COMMAND -r -d $WORKDIR -D $TEST >/dev/null
}

# This is used to verify special handling for /etc/mail/aliases and
# the newaliases warning.
proc build_aliases_conflict
{

	rm -rf $OLD $NEW $TEST $CONFLICTS
	mkdir -p $OLD/etc/mail $NEW/etc/mail $TEST/etc/mail

	# Generate a conflict in /etc/mail/aliases
	cat > $OLD/etc/mail/aliases << """
# root: me@my.domain

# Basic system aliases -- these MUST be present
MAILER-DAEMON: postmaster
postmaster: root
"""
	cat > $NEW/etc/mail/aliases << """
# root: me@my.domain

# Basic system aliases -- these MUST be present
MAILER-DAEMON: postmaster
postmaster: root

# General redirections for pseudo accounts
_dhcp:  root
_pflogd: root
"""
	cat > $TEST/etc/mail/aliases << """
root: someone@example.com

# Basic system aliases -- these MUST be present
MAILER-DAEMON: postmaster
postmaster: foo
"""

	$COMMAND -r -d $WORKDIR -D $TEST >/dev/null
}

# $1 - relative path to file that should be missing from TEST
proc missing
{
	if test -e $TEST/$1 -o -L $TEST/$1 {
		echo "File $1 should be missing"
		setglobal FAILED = 'yes'
	}
}

# $1 - relative path to file that should be present in TEST
proc present
{
	if ! test -e $TEST/$1 -o -L $TEST/$1 {
		echo "File $1 should be present"
		setglobal FAILED = 'yes'
	}
}

# $1 - relative path to regular file that should be present in TEST
# $2 - optional string that should match file contents
# $3 - optional MD5 of the flie contents, overrides $2 if present
proc file
{
	local contents sum

	if ! test -f $TEST/$1 {
		echo "File $1 should be a regular file"
		setglobal FAILED = 'yes'
	} elif test $Argc -eq 2 {
		setglobal contents = $[cat $TEST/$1]
		if test $contents != $2 {
			echo "File $1 has wrong contents"
			setglobal FAILED = 'yes'
		}
	} elif test $Argc -eq 3 {
		setglobal sum = $[md5 -q $TEST/$1]
		if test $sum != $3 {
			echo "File $1 has wrong contents"
			setglobal FAILED = 'yes'
		}
	}
}

# $1 - relative path to a regular file that should have a conflict
# $2 - optional MD5 of the conflict file contents
proc conflict
{
	local sum

	if ! test -f $CONFLICTS/$1 {
		echo "File $1 missing conflict"
		setglobal FAILED = 'yes'
	} elif test $Argc -gt 1 {
		setglobal sum = $[md5 -q $CONFLICTS/$1]
		if test $sum != $2 {
			echo "Conflict $1 has wrong contents"
			setglobal FAILED = 'yes'
		}
	}
}

# $1 - relative path to a regular file that should no longer have a conflict
proc resolved
{
	if test -f $CONFLICTS/$1 {
		echo "Conflict $1 should be resolved"
		setglobal FAILED = 'yes'
	}
}

if test $[id -u] -ne 0 {
	echo "must be root"
	exit 0
}

if test -r /etc/etcupdate.conf {
	echo "WARNING: /etc/etcupdate.conf settings may break some tests."
}

# Test each of the following resolve options: 'p', 'mf', 'tf', 'r'.

build_login_conflict

# Verify that 'p' doesn't do anything.
echo "Checking 'p':"
echo 'p' | $COMMAND resolve -d $WORKDIR -D $TEST >/dev/null

file /etc/login.conf "" 95de92ea3f1bb1bf4f612a8b5908cddd
missing /etc/login.conf.db
conflict /etc/login.conf

# Verify that 'mf' removes the conflict, but does nothing else.
echo "Checking 'mf':"
echo 'mf' | $COMMAND resolve -d $WORKDIR -D $TEST >/dev/null

file /etc/login.conf "" 95de92ea3f1bb1bf4f612a8b5908cddd
missing /etc/login.conf.db
resolved /etc/login.conf

build_login_conflict

# Verify that 'tf' installs the new version of the file.
echo "Checking 'tf':"
echo 'tf' | $COMMAND resolve -d $WORKDIR -D $TEST >/dev/null

file /etc/login.conf "" 7774a0f9a3a372c7c109c32fd31c4b6b
file /etc/login.conf.db
resolved /etc/login.conf

build_login_conflict

# Verify that 'r' installs the resolved version of the file.  To
# simulate this, manually edit the merged file so that it doesn't
# contain conflict markers.
echo "Checking 'r':"
cat > $CONFLICTS/etc/login.conf << """
default:'\'
	:passwd_format=md5:'\'
	:copyright=/etc/COPYRIGHT'\'
        :welcome=/etc/motd:
"""

echo 'r' | $COMMAND resolve -d $WORKDIR -D $TEST >/dev/null

file /etc/login.conf "" 966e25984b9b63da8eaac8479dcb0d4d
file /etc/login.conf.db
resolved /etc/login.conf

build_aliases_conflict

# Verify that 'p' and 'mf' do not generate the newaliases warning.
echo "Checking newalias warning for 'p'":
echo 'p' | $COMMAND resolve -d $WORKDIR -D $TEST | grep -q newalias
if test $Status -eq 0 {
	echo "+ Extra warning"
	setglobal FAILED = 'yes'
}
echo "Checking newalias warning for 'mf'":
echo 'mf' | $COMMAND resolve -d $WORKDIR -D $TEST | grep -q newalias
if test $Status -eq 0 {
	echo "+ Extra warning"
	setglobal FAILED = 'yes'
}

# Verify that 'tf' and 'r' do generate the newaliases warning.
build_aliases_conflict
echo "Checking newalias warning for 'tf'":
echo 'tf' | $COMMAND resolve -d $WORKDIR -D $TEST | grep -q newalias
if test $Status -ne 0 {
	echo "- Missing warning"
	setglobal FAILED = 'yes'
}

build_aliases_conflict
cp $TEST/etc/mail/aliases $CONFLICTS/etc/mail/aliases
echo 'r' | $COMMAND resolve -d $WORKDIR -D $TEST | grep -q newalias
if test $Status -ne 0 {
	echo "- Missing warning"
	setglobal FAILED = 'yes'
}

test $(FAILED) = no