Files
OpenUxAS/anod

77 lines
2.4 KiB
Plaintext
Raw Permalink Normal View History

Bootstrap Integration (#24) * Integrate OpenUxAS-bootstrap into OpenUxAS This commit represents a complete, working integration along with several key enhancements. Note that the README is entirely unchanged and not suitable. ***NOTE: the build will fail currently because of a problem with e3*** e3 provides no way to modify the list of excluded globs for sync_tree; this will need to be fixed. The bootstrap script works and will download and install needed support for anod. The instructions printed at the end of the install are out of date; the user doesn't need to do anything more than call anod with ./anod build uxas The top-level anod script takes care of activating the python venv and then calls the python anod script. The user can also `source anod`, which will then register anod as a shell function, allowing simpler invocation and a working setenv command. Anod's devel setup no longer supports uxas, since that's superfluous. It does support lmcpgen and amase. They are placed in `develop` as before, although finding a better name for the containing directory seems nice. run-example works, as does resources/RunLmcpGen make works VS Code integration works There is definite room for improvement. Specifically, factoring the informtion about repository structure into some central set of includable scripts seems like it should be really useful. Likewise, anod's support should be a real python module so that it's easier to use. Finally, there's no reason not to automatically install the python venv and all needed support the first time anod is invokved (including from make). This would eliminate a needed step by the user. We could still retain the bootstrap script if desired. * Rename and create constants for repo structure This commit reorganizes the directories a bit and introduces better handling of pathnames through constants defined in paths.sh. Unfortunately, because of the way python handles environment variables, (and because we can't necessarily assume that python scripts are always invoked through shell scripts that call paths.sh) we have to duplicate a lot of the path information; this will hopefully be addressed in a future commit. * Refactor infrastructure and add github workflows. OpenUxAS anod support is now a proper python module named `uxas`. Paths within the uxas module are refactored. The module directory under infrastructure/uxas has the expected layout for a python module project and includes a tox.ini file so that tox can be used for development and in CI. infrastructure/install is now a script that calls into python scripts in infrastructure/install-libexec; these are not a proper python module, since that would create a chicken-and-egg problem. There is a tox.ini file here, too, for development and CI. infrastructure/bootstrap is the new bootstrap script, which is less useful now but still usable. Scripts have been updated as needed to take advantage of the uxas python module. In particular, anod and run-example check for the python venv and call into infrastructure/install if needed. * Add Ada support and improve scripts Added support for Ada back in by reactivating and updating install-gnat.py Added Ada build-prove workflow Refactored venv activation to paths.sh Added ensure_gnat, which will check for gnat on the path (via which) or will add a local install of GNAT CE to the path (if it's there) or will offer to install GNAT CE via install-gnat.py This means the user can always choose a different GNAT and it will be used; otherwise, the local install of GNAT CE will be used. Added wrapper shell scripts for the python testing and proof scripts so that the environment can be automatically configured. Updated the C++ workflow Note: sourcing anod and then running anod as a shell function isn't behaving quite right in either bash or zsh (and for different reasons). Needs further investigation. * Add debug output to print commands executed. This should address concern that users won't be able to figure out what the scripts are doing if things break and require manual intervention. Also modify the workflows so that they will run if critical scripts are updated. * Enhance run-example to better search for binaries. run-example now follows similar logic to run-tests in searching for binaries. uxas and uxas-ada are also special-cased so that searching locally and in anod should succeed as expected. The search order is: 1. path (using `which`) 2. local (obj/cpp/uxas or src/ada/uxas-ada) 3. anod (inside uxas-release or uxas-ada-release) run-example also follows similar logic in search for OpenAMASE: 1. specified via argument 2. local (develop/OpenAMASE) 3. anod (inside amse) I believe these have all been tested. Help / error strings have been updated so that they are consistent with the new infrastructure. Debug output has been improved to be more consistent with that provided by e3 (but doesn't actually directly use e3, still). This commit also improves the .gitignore for ada support and updates the Makefile so that it removes the binary on clean. * Update README and scripts. Create a temporary README with testing instructions. Also fix some issues in the debug output of the scripts (the $ was not escaped properly in some instances). * Relativize path to anod in run-example This looks nicer and better supports the common case: in which the user runs run-example from the repo root. * Fix python version in Makefile Makefile was using python to determine the platform; this was one of a few remaining non-python3 uses of `python`. Having fixed it, things seem to work smoothly on a machine where python ≠ python3. * Don't install GNAT CE by default. Most users won't want to build Ada, so offering to install GNAT CE by default is likely to just be confusing. * Change the way Java is installed. Rather than installing Java (OpenJDK 13) by way of anod in the sandbox, instead install Java (OpenJDK 11) by way of apt. This results in Java being available system-wide and avoids having to put ant/java on the path using anod commands for things like generating LMCP. Update workflows to install Java using the appropriate github action. This should reduce the number of spurious build failures we've encountered. * Fix run-example issue for uxas-ada. The shared library for uxas-ada wasn't being placed on the path. Additionally, there was an unconditional and unlogged exit leftover from testing in the python script. * Update anod self-install process to be automatic. Rather than running the install script in interactive mode, give the user a full message up front that explains what will happen, followed by a choice to continue. Then, run the install script in automatic mode. This avoids some confusion identified whereby the script seems to ask multiple times to do things in a way that's not particularly helpful when the expectation is that it will just "take care of things" for the user. * Update the README This new version of the README is tailored to the changes that were made to integrated -bootstrap into this repository. It is intended to be minimal and simple. Detail will be provided later to the documentation site that AFRL is setting up. Once that site is live, links will be made from this README to that site. * Improve script with debug_and_run Rather than printing the string for a command and then separately issuing the command, we pass the string form of the command to a debug print method and then eval the string. This removes duplication and ensures that the printed command really is the command that is executed. * Minor improvements to README Fix a couple of typos.
2021-04-01 15:30:51 -04:00
#! /usr/bin/env bash
#
# Anod wrapper script.
#
# Note that this script is meant to either be run directly by the user or is
# meant to be sourced. In the former case, we can assume we're running bash. In
# the latter case, we're in the user's current shell. We support bash and zsh.
# Support for ksh is incomplete.
# Script location
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
# Load global paths
source "${SCRIPT_DIR}/infrastructure/paths.sh"
# Determine if we're being sourced (BASH, KSH, and ZSH compliant):
([[ -n $ZSH_EVAL_CONTEXT && $ZSH_EVAL_CONTEXT =~ :file$ ]] ||
[[ -n $KSH_VERSION && $(cd "$(dirname -- "$0")" &&
printf '%s' "${PWD%/}/")$(basename -- "$0") != "${.sh.file}" ]] ||
[[ -n $BASH_VERSION ]] && (return 0 2>/dev/null)) && sourced=1 || sourced=0
ANOD_SCRIPT="from uxas.cli.anod import do_cli; exit(do_cli())"
# Define a shell function for anod.
function _anod {
# Activate the python venv
activate_venv
# Look ahead to see if we're building uxas-ada
if is_first_positional_arg "$*" "build" && contains "$*" "uxas-ada"; then
ensure_gnat
fi
# Look ahead to process specific commands.
command=$( get_first_positional_arg "$*" )
case ${command} in
build)
# Are we building? if so, we should set the SHELL variable to bash;
# zsh will not work correctly with boost.
debug_and_run "SHELL=$( which bash ) python3 -c \"${ANOD_SCRIPT}\" $*"
;;
setenv)
if [[ -n ${_DIRECT_EXEC} ]]; then
echo "Can't setenv: anod was not called as shell function."
echo " "
echo "try \`source ./anod\` and then call anod without the ./ like this:"
echo "\`anod setenv\`"
return 1
else
debug_and_run "eval \"\$( python3 -c \"${ANOD_SCRIPT}\" printenv ${@/$command} )\""
fi
;;
reset)
debug_and_run "rm -rf \"${SBX_DIR}\""
;;
*)
debug_and_run "python3 -c \"${ANOD_SCRIPT}\" $*"
;;
esac
}
# If we're not being sourced, then try to run the command the user requested.
if [ $sourced -eq 0 ]; then
_DIRECT_EXEC=0
_anod $@
else
# If the user sources this file, install anod as a shell function
function anod {
_anod $@
}
fi