ysh-ify.sh

#!/usr/bin/env bash
#
# Test ysh-prettify transformations
#
# Usage:
#   ./ysh-ify.sh <function name>

: ${LIB_OSH=stdlib/osh}
source $LIB_OSH/bash-strict.sh
source $LIB_OSH/task-five.sh

source test/common.sh  # $OSH

readonly TEMP_DIR=_tmp

prettify-one() {
  local file=$1

  set +o errexit
  $OSH --tool ysh-ify "$file"
  local status=$?
  set +o errexit

  if test $status = 0; then
    echo "    (DONE $file)"
  else
    echo "    FAIL: $file"
    return 255  # xargs FAILURE
  fi
}

smoke-test() {
  ### Run it against many of our files
  find build benchmarks -name '*.sh' | xargs -n 1 -- $0 prettify-one
}

run-all() {
  ### For both CI and release.  
  
  # Note: might want to split these up.

  run-test-funcs

  smoke-test
}

soil-run() {
  run-all
}

soil-run-cpp() {
  ### Not used yet, but it works

  local osh=_bin/cxx-asan/osh
  ninja $osh

  #OSH=$osh run-test-funcs
  OSH=$osh run-all
}

run-for-release() {
  run-other-suite-for-release ysh-ify run-all
}


#
# Test Harness
#

check-osh2ysh() {
  local osh_str=$1
  local ysh_str=$2  # expected
  local allow_invalid=${3:-}

  # Make sure they are valid

  bin/osh -n -c "$osh_str"
  if test -z "$allow_invalid"; then
    bin/ysh -n -c "$ysh_str"
  fi

  local tmp=$TEMP_DIR/actual.ysh
  echo "$osh_str" | bin/osh --tool ysh-ify | tee $tmp

  echo "$ysh_str" | diff -u $tmp -
  echo 'OK'

  # TODO: Also create a variant that tests equal STDOUT and STATUS!
  # probably assert no stderr
  #
  # For backticks, etc.
}

#
# UNCHANGED
#

test-simple-command() {
  ### Unchanged

  check-osh2ysh 'echo hi' 'echo hi'
}


test-line-breaks() {
  ### Unchanged

  check-osh2ysh '
echo one \
  two three \
  four
' '
echo one \
  two three \
  four
'
}

test-and-or() {
  check-osh2ysh \
    'ls && echo "$@" || die "foo"' \
    'ls && echo @ARGV || die "foo"'
}

#
# CHANGED WORD LANGUAGE
#

test-dollar-at() {
  check-osh2ysh \
    'echo one "$@" two' \
    'echo one @ARGV two'
}

TODO-test-prefix-ops() {
  check-osh2ysh \
    'echo ${#s} ${#a[@]}' \
    'echo $[len(s)] $[len(a)]'
}

test-unquote-subs-TODO() {
  check-osh2ysh \
    'echo "$1" "$foo"' \
    'echo $1 $foo'

  check-osh2ysh \
    'echo "$(echo hi)"' \
    'echo $(echo hi)' 

  return
  # TODO: echo $foo
  check-osh2ysh \
    'echo "${foo}"' \
    'echo $foo'
}

TODO-test-word-joining() {
  local osh=$(cat <<EOF
echo 'foo " bar '"'" 
EOF
)

  # TODO: Use new YSTR syntax!
  local ysh=$(cat <<EOF
echo y"foo \" bar '"
EOF
)
  check-osh2ysh "$osh" "$ysh"
}

# Unchanged
test-command-sub() {
  check-osh2ysh \
    'echo $(echo hi)' \
    'echo $(echo hi)' 

  check-osh2ysh \
    'echo "__$(echo hi)__"' \
    'echo "__$(echo hi)__"' 
}

test-var-sub() {
  # Unchanged
  check-osh2ysh \
    'echo $foo' \
    'echo $foo'

  # Could just be $bar
  check-osh2ysh \
    'echo $foo ${bar} "__${bar}__"' \
    'echo $foo ${bar} "__${bar}__"'

  return

  # We could make this $[foo ? 'default'], but meh, let's not introduce more
  # operators
  #
  # Better is getvar('foo', 'default')

  check-osh2ysh \
    'echo ${foo:-default}' \
    "echo $[getvar('foo', 'default')]"
}

# Downgraded to one_pass_parse.  This means \" will be wrong, but meh.
# Here the WordParser makes another pass with CommandParser.
#
# We could also translate it to:
#   echo $[compat backticks 'echo hi']
# But that might be overly pedantic.  This will work most of the time.

test-backticks-TODO() {
  check-osh2ysh \
   'echo `echo hi ${var}`' \
   'echo $(echo hi ${var})' 

  check-osh2ysh \
    'echo $({ echo hi; })' \
    'echo $({ echo hi; })' 

  # TODO: Fix this
  check-osh2ysh \
    'echo `{ echo hi; }`' \
    'echo $(do { echo hi)' \
    INVALID
}

#
# CHANGED BUILTIN LANGUAGE
#

test-bracket-builtin() {
  check-osh2ysh \
    '[ ! -z "$foo" ] || die' \
    'test ! -z $foo || die'

  # Don't touch this invalid code?
  check-osh2ysh \
    '[ ] || die' \
    '[ ] || die'

  check-osh2ysh '
if [ "$foo" -eq 3 ]; then
  echo yes
fi' \
  '
if test $foo -eq 3 {
  echo yes
}'
}

test-source-builtin() {
  check-osh2ysh \
    '. lib.sh' \
    'source lib.sh'

  check-osh2ysh \
    '[ -f lib.sh ] && . lib.sh' \
    'test -f lib.sh && source lib.sh'
}

TODO-test-set-builtin() {
  # Not as important now that we have 'setvar'
  check-osh2ysh \
    'set -o errexit' \
    'shopt --set errexit'
}

# 
# CHANGED COMMAND LANGUAGE
#

test-here-doc() {
  check-osh2ysh '
cat <<EOF
hi
EOF
' '
cat <<< """
hi
"""
'

  check-osh2ysh "
cat <<'EOF'
hi
EOF
" "
cat <<< '''
hi
'''
"
}

test-bare-assign-TODO() {
  check-osh2ysh "
a=
" "
setvar a = ''
"

  check-osh2ysh "
a=b
" "
setvar a = 'b'
"

  # TODO: Make it quoted
  if false; then
  check-osh2ysh '
a="$x"
' '
setvar a = "$x"
'
  fi

  check-osh2ysh '
a=$(hostname)
' '
setvar a = $(hostname)
'

  check-osh2ysh '
a=${PATH:-}
' '
setvar a = ${PATH:-}
'

  return
  check-osh2ysh '
a=$x
' '
setvar a = "$x"
'

}

TODO-test-assign-builtins() {
  check-osh2ysh "
local a=
" "
var a = ''
"

  check-osh2ysh "
local a=b
" "
var a = 'b'
"

  # TODO: more test cases

  check-osh2ysh "
readonly a=b
" "
const a = 'b'
"
}

test-while-loop() {
  check-osh2ysh '
while read line; do
  echo $line
done' \
  '
while read line {
  echo $line
}'

  check-osh2ysh '
while read \
  line; do
  echo $line
done' \
  '
while read \
  line {
  echo $line
}'
}

test-if() {
  check-osh2ysh '
if true; then
  echo yes
fi' \
  '
if true {
  echo yes
}'

  check-osh2ysh '
if true; then
  echo yes
elif false; then
  echo elif
elif spam; then
  echo elif
else
  echo no
fi' \
  '
if true {
  echo yes
} elif false {
  echo elif
} elif spam {
  echo elif
} else {
  echo no
}'

  # Redirect
  check-osh2ysh '
if true; then
  echo yes
fi > out' \
  '
if true {
  echo yes
} > out'
}

TODO-test-then-next-line() {
  # TODO: Brace must be on same line
  check-osh2ysh '
if true
then
  echo yes
fi' \
  '
if true {
  echo yes
}'

}

test-posix-func() {
  check-osh2ysh '
  f() {
    echo "hi"
  }' '
  proc f {
    echo "hi"
  }'

  # The brace is moved
  check-osh2ysh '
  f()
  {
    echo "hi"
  }' '
  proc f {
    echo "hi"
  }'

  return

  # Nested functinos
  check-osh2ysh '
func1() {
  echo func1
  func2()
  {
    echo func2
  }
}' \
  '
proc func1 {
  echo func1
  proc func2
  {
    echo func2
  }
}'
  return

  # Non-brace function bodies
  # TODO: Bail in this case
  check-osh2ysh '
  f() (
    echo hi
  )' \
  '
  proc f (
    echo hi
  )' \
  INVALID
}

test-ksh-func() {
  check-osh2ysh '
function func1 {  # no parens
  echo func1
}' '
proc func1 {  # no parens
  echo func1
}'
}

test-for-loop() {
  check-osh2ysh '
for x in a b c \
  d e f; do
  echo $x
done
' '
for x in a b c \
  d e f {
  echo $x
}
'

  check-osh2ysh '
for x in a b c \
  d e f
do
  echo $x
done
' '
for x in a b c \
  d e f
{
  echo $x
}
'
}

test-empty-for-loop() {
  check-osh2ysh '
for x in
do
  echo $x
done
' '
for x in
{
  echo $x
}
'
}

test-args-for-loop() {
  # Why are we missing a newline here?
  check-osh2ysh '
for x; do
  echo $x
done
' 'for x in @ARGV {
  echo $x
}
'
  # Change brace style

  check-osh2ysh '
for x
do
  echo $x
done
' 'for x in @ARGV {
  echo $x
}
'
}

# TODO: translate to forkwait { proper spaces }

test-subshell() {
  check-osh2ysh \
    '(echo hi;)' \
    'shell {echo hi;}' \
    INVALID

  check-osh2ysh \
    '(echo hi)' \
    'shell {echo hi}' \
    INVALID

  check-osh2ysh \
    '(echo hi; echo bye)' \
    'shell {echo hi; echo bye}' \
    INVALID

  check-osh2ysh \
    '( (echo hi; echo bye ) )' \
    'shell { shell {echo hi; echo bye } }' \
    INVALID
}

test-brace-group() {
  check-osh2ysh \
    '{ echo hi; }' \
    'do { echo hi; }' \
    INVALID

  check-osh2ysh \
    '{ echo hi; echo bye; }' \
    'do { echo hi; echo bye; }' \
    INVALID
}

# TODO: New case syntax, which looks like
# 
# case (myvar) {
#   *.cc | *.h { echo 'C++' }
# }

# case (myvar) {
#   *.cc | *.h {
#     echo 'C++'
#   }
# }

test-case() {
  check-osh2ysh '
case $var in
  foo|bar)
    [ -f foo ] && echo file
    ;;
  "")
    echo empty
    ;;
  *)
    echo default
    ;;
esac
' '
case (var) {
  foo|bar {
    test -f foo && echo file
    }
  "" {
    echo empty
    }
  * {
    echo default
    }
}
'

  check-osh2ysh '
case "$var" in
  *)
    echo foo
    echo bar  # no dsemi
esac
' '
case (var) {
  * {
    echo foo
    echo bar  # no dsemi
}
}
'
}

task-five "$@"