1#!/bin/sh 2# 3# $OpenBSD: getopt.sh,v 1.2 2020/05/27 22:32:22 schwarze Exp $ 4# 5# Copyright (c) 2020 Ingo Schwarze <schwarze@openbsd.org> 6# 7# Permission to use, copy, modify, and distribute this software for any 8# purpose with or without fee is hereby granted, provided that the above 9# copyright notice and this permission notice appear in all copies. 10# 11# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 12# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 13# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 14# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 15# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 16# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 17# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 18 19# Run ./getopt-test once. 20# Function arguments: 21# 1. optstring argument for getopt(3) 22# 2. space-separated command line arguments 23# 3. expected output from ./getopt-test 24test1_getopt() 25{ 26 result=$(OPTS=$1 ./getopt-test $2) 27 test "$result" == "$3" && return 28 echo "OPTS=$1 ./getopt-test $2" 29 echo "expected: $3" 30 echo "result: $result" 31 irc=1 32} 33 34# Test both without and with the optstring modifier "+", 35# verifying that it makes no difference. 36test2_getopt() 37{ 38 test1_getopt "$1" "$2" "$3" 39 test1_getopt "+$1" "$2" "$3" 40} 41 42# Also test with the GNU "-" optstring modifier, 43# veryfying that it only changes ARG() to NONE(). 44# This test function is inadequate in two situations: 45# a) options follow non-option arguments that terminate option processing 46# b) or any arguments follow explicit "--". 47# In these cases, use test2_getopt() plus a separate test1_getopt(-...). 48test3_getopt() 49{ 50 test2_getopt "$1" "$2" "$3" 51 test1_getopt "-$1" "$2" $(echo $3 | sed s/ARG/NONE/g) 52} 53 54irc=0 55 56# valid isolated options without arguments 57test3_getopt ax '-a -x arg' 'OPT(a)OPT(x)ARG(arg)' 58test3_getopt x- '- -x arg' 'OPT(-)OPT(x)ARG(arg)' 59 60# invalid isolated options without arguments 61test3_getopt ax '-a -y arg' 'OPT(a)ERR(?y)ARG(arg)' 62test1_getopt :ax '-a -y arg' 'OPT(a)ERR(?y)ARG(arg)' 63test2_getopt x '- -x arg' 'ARG(-)ARG(-x)ARG(arg)' 64test1_getopt -x '- -x arg' 'NONE(-)OPT(x)NONE(arg)' 65test3_getopt a- '-a - -x arg' 'OPT(a)OPT(-)ERR(?x)ARG(arg)' 66test1_getopt :a- '-a - -x arg' 'OPT(a)OPT(-)ERR(?x)ARG(arg)' 67 68# valid grouped options without arguments 69test3_getopt ax '-ax arg' 'OPT(a)OPT(x)ARG(arg)' 70test3_getopt ax- '-a- -x arg' 'OPT(a)OPT(-)OPT(x)ARG(arg)' 71test3_getopt abx- '-a-b -x arg' 'OPT(a)OPT(-)OPT(b)OPT(x)ARG(arg)' 72test3_getopt ax- '--a -x arg' 'OPT(-)OPT(a)OPT(x)ARG(arg)' 73 74# invalid grouped options without arguments 75test3_getopt ax '-ay arg' 'OPT(a)ERR(?y)ARG(arg)' 76test1_getopt :ax '-ay arg' 'OPT(a)ERR(?y)ARG(arg)' 77test3_getopt ax '-a- -x arg' 'OPT(a)ERR(?-)OPT(x)ARG(arg)' 78test1_getopt :ax '-a- -x arg' 'OPT(a)ERR(?-)OPT(x)ARG(arg)' 79test3_getopt abx '-a-b -x arg' 'OPT(a)ERR(?-)OPT(b)OPT(x)ARG(arg)' 80test1_getopt :abx '-a-b -x arg' 'OPT(a)ERR(?-)OPT(b)OPT(x)ARG(arg)' 81test3_getopt ax '--a -x arg' 'ERR(?-)OPT(a)OPT(x)ARG(arg)' 82test1_getopt :ax '--a -x arg' 'ERR(?-)OPT(a)OPT(x)ARG(arg)' 83 84# non-option arguments terminating option processing 85test2_getopt ax '-a arg -x' 'OPT(a)ARG(arg)ARG(-x)' 86test1_getopt -ax '-a arg1 -x arg2' 'OPT(a)NONE(arg1)OPT(x)NONE(arg2)' 87test2_getopt ax '-a -- -x' 'OPT(a)ARG(-x)' 88test1_getopt -ax '-a -- -x' 'OPT(a)ARG(-x)' 89test2_getopt ax '-a - -x' 'OPT(a)ARG(-)ARG(-x)' 90test1_getopt -ax '-a - -x arg' 'OPT(a)NONE(-)OPT(x)NONE(arg)' 91 92# the ':' option never works 93test1_getopt ::a '-:a arg' 'ERR(?:)OPT(a)ARG(arg)' 94test1_getopt :::a '-: arg -a' 'ERR(?:)ARG(arg)ARG(-a)' 95 96# isolated options with arguments 97test3_getopt o: '-o' 'ERR(?o)' 98test1_getopt :o: '-o' 'ERR(:o)' 99test3_getopt o-: '-' 'ERR(?-)' 100test1_getopt :-: '-' 'ERR(:-)' 101test3_getopt o:x '-o arg -x arg' 'OPT(oarg)OPT(x)ARG(arg)' 102test3_getopt o:x '-oarg -x arg' 'OPT(oarg)OPT(x)ARG(arg)' 103test3_getopt o::x '-oarg -x arg' 'OPT(oarg)OPT(x)ARG(arg)' 104test2_getopt o::x '-o arg -x' 'OPT(o)ARG(arg)ARG(-x)' 105test1_getopt -o::x '-o arg1 -x arg2' 'OPT(o)NONE(arg1)OPT(x)NONE(arg2)' 106test3_getopt o:x '-o -x arg' 'OPT(o-x)ARG(arg)' 107test3_getopt o:x '-o -- -x arg' 'OPT(o--)OPT(x)ARG(arg)' 108test3_getopt x-: '- arg -x arg' 'OPT(-arg)OPT(x)ARG(arg)' 109test3_getopt x-: '--arg -x arg' 'OPT(-arg)OPT(x)ARG(arg)' 110test3_getopt x-:: '--arg -x arg' 'OPT(-arg)OPT(x)ARG(arg)' 111test2_getopt x-:: '- arg -x' 'OPT(-)ARG(arg)ARG(-x)' 112test1_getopt --::x '- arg1 -x arg2' 'OPT(-)NONE(arg1)OPT(x)NONE(arg2)' 113test3_getopt x-: '- -x arg' 'OPT(--x)ARG(arg)' 114test3_getopt x-: '- -- -x arg' 'OPT(---)OPT(x)ARG(arg)' 115 116# grouped options with arguments 117test3_getopt ao: '-ao' 'OPT(a)ERR(?o)' 118test1_getopt :ao: '-ao' 'OPT(a)ERR(:o)' 119test3_getopt a-: '-a-' 'OPT(a)ERR(?-)' 120test1_getopt :a-: '-a-' 'OPT(a)ERR(:-)' 121test3_getopt ao:x '-ao arg -x arg' 'OPT(a)OPT(oarg)OPT(x)ARG(arg)' 122test3_getopt ao:x '-aoarg -x arg' 'OPT(a)OPT(oarg)OPT(x)ARG(arg)' 123test3_getopt ao::x '-aoarg -x arg' 'OPT(a)OPT(oarg)OPT(x)ARG(arg)' 124test2_getopt ao::x '-ao arg -x' 'OPT(a)OPT(o)ARG(arg)ARG(-x)' 125test1_getopt -ao::x '-ao arg1 -x arg2' 'OPT(a)OPT(o)NONE(arg1)OPT(x)NONE(arg2)' 126test3_getopt ao:x '-ao -x arg' 'OPT(a)OPT(o-x)ARG(arg)' 127test3_getopt ao:x '-ao -- -x arg' 'OPT(a)OPT(o--)OPT(x)ARG(arg)' 128test3_getopt a-:x '-a- arg -x arg' 'OPT(a)OPT(-arg)OPT(x)ARG(arg)' 129test3_getopt a-:x '-a-arg -x arg' 'OPT(a)OPT(-arg)OPT(x)ARG(arg)' 130test3_getopt a-::x '-a-arg -x arg' 'OPT(a)OPT(-arg)OPT(x)ARG(arg)' 131test2_getopt a-::x '-a- arg -x' 'OPT(a)OPT(-)ARG(arg)ARG(-x)' 132test1_getopt -a-::x '-a- arg1 -x arg2' 'OPT(a)OPT(-)NONE(arg1)OPT(x)NONE(arg2)' 133test3_getopt a-:x '-a- -x arg' 'OPT(a)OPT(--x)ARG(arg)' 134test3_getopt a-:x '-a- -- -x arg' 'OPT(a)OPT(---)OPT(x)ARG(arg)' 135 136exit $irc 137