ada/OpenUxAS
0
0
Fork 0
mirror of https://github.com/AdaCore/OpenUxAS.git synced 2026-02-12 13:07:16 -08:00
Code Issues Packages Projects Releases Wiki Activity
Files
develop
OpenUxAS/run-example

19 lines
583 B
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
#
# run-example wrapper script.
Feature/create run example (#40) * Intermediate progress * Update run-example Delaying while OpenAMASE opens appears to be important. It takes a while for OpenAMASE to actually open, and the user is supposed to click on the run button before OpenUxAS instances start. The five seconds offered by some examples is insufficient, and may not be guaranteed in any case. We make the delay configurable, so that the user can remove or adjust it, as needed. We also make sure that we kill off forked subprocesses and report if we're unable to do so. * Rename the Ada Waterway Search example Suggesting this naming convention so that we can create other examples that use the Ada UxAS more easily. * Add two additional configs Configs for Examples 03 and 05 * Update config for example 03 This should work out of the box on modern Linux. * Add config-driven delay after OpenAMASE starts This is important for the Ada example, although it may be related to the way in which we implemented it. * Enhance run-example - Fix error when OpenAMASE does not run - Handle Ctrl-C gracefully (shut down all subprocesses) - Allow a relative or absolute path to the example to be specified - this is nice, because then tab-complete works * Add missing example configs Also make sure that each ends with a newline (nice for `cat`). * Use Test_SimulationTime service to sync with AMASE Removes the need for any timeout to start UxAS instances. * Fix example 05_AssignTasks Adding the Test_SimulationTime service + a longer timeout on task assignment allows the example to run correctly.
2020-05-14 13:49:06 -04:00
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
# Script location
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
Feature/lint run example (#2) * [No-TN] Add typing and fix documentation. Passes mypy, flake8 and pydocstyle. Formatted with black, albeit with -l79.
2020-08-05 14:48:04 -04:00
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
# Load global paths
source "${SCRIPT_DIR}/infrastructure/paths.sh"
Feature/create run example (#40) * Intermediate progress * Update run-example Delaying while OpenAMASE opens appears to be important. It takes a while for OpenAMASE to actually open, and the user is supposed to click on the run button before OpenUxAS instances start. The five seconds offered by some examples is insufficient, and may not be guaranteed in any case. We make the delay configurable, so that the user can remove or adjust it, as needed. We also make sure that we kill off forked subprocesses and report if we're unable to do so. * Rename the Ada Waterway Search example Suggesting this naming convention so that we can create other examples that use the Ada UxAS more easily. * Add two additional configs Configs for Examples 03 and 05 * Update config for example 03 This should work out of the box on modern Linux. * Add config-driven delay after OpenAMASE starts This is important for the Ada example, although it may be related to the way in which we implemented it. * Enhance run-example - Fix error when OpenAMASE does not run - Handle Ctrl-C gracefully (shut down all subprocesses) - Allow a relative or absolute path to the example to be specified - this is nice, because then tab-complete works * Add missing example configs Also make sure that each ends with a newline (nice for `cat`). * Use Test_SimulationTime service to sync with AMASE Removes the need for any timeout to start UxAS instances. * Fix example 05_AssignTasks Adding the Test_SimulationTime service + a longer timeout on task assignment allows the example to run correctly.
2020-05-14 13:49:06 -04:00
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
# Activate the python venv
activate_venv
Feature/create run example (#40) * Intermediate progress * Update run-example Delaying while OpenAMASE opens appears to be important. It takes a while for OpenAMASE to actually open, and the user is supposed to click on the run button before OpenUxAS instances start. The five seconds offered by some examples is insufficient, and may not be guaranteed in any case. We make the delay configurable, so that the user can remove or adjust it, as needed. We also make sure that we kill off forked subprocesses and report if we're unable to do so. * Rename the Ada Waterway Search example Suggesting this naming convention so that we can create other examples that use the Ada UxAS more easily. * Add two additional configs Configs for Examples 03 and 05 * Update config for example 03 This should work out of the box on modern Linux. * Add config-driven delay after OpenAMASE starts This is important for the Ada example, although it may be related to the way in which we implemented it. * Enhance run-example - Fix error when OpenAMASE does not run - Handle Ctrl-C gracefully (shut down all subprocesses) - Allow a relative or absolute path to the example to be specified - this is nice, because then tab-complete works * Add missing example configs Also make sure that each ends with a newline (nice for `cat`). * Use Test_SimulationTime service to sync with AMASE Removes the need for any timeout to start UxAS instances. * Fix example 05_AssignTasks Adding the Test_SimulationTime service + a longer timeout on task assignment allows the example to run correctly.
2020-05-14 13:49:06 -04:00
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
# Just in case, for uxas-ada. A bit ugly and special-purpose. Use build-env to
Improve run_example.py Recent updates to linters revealed a number of potential code-quality issues. Most were related to the use of f-strings in loggers, which is discouraged because the string interpolation is greedy (happens even if that logging level is disabled) and because it makes the job of log aggregators more difficult (unlikely to matter to us). There was an instance of use of a "global" that was not intended to be such. This was spotted by moving the core script-like functionality into a function, which avoided adding names to the global namespace. The script is also renamed to conform to python module-naming conventions. All warnings and errors are resolved, except the overly broad catching of Exception, which is explicitly silenced. Add a workflow for running the HelloWorld example in CI as a simple sanity check on run-example functionality.
2022-03-15 17:15:26 -04:00
# avoid directly putting uxas-ada itself on the path (in case there's a local
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
# build)
debug_and_run "eval \"\$( \"${OPENUXAS_ROOT}/anod\" printenv uxas-ada --build-env )\""
Improve run_example.py Recent updates to linters revealed a number of potential code-quality issues. Most were related to the use of f-strings in loggers, which is discouraged because the string interpolation is greedy (happens even if that logging level is disabled) and because it makes the job of log aggregators more difficult (unlikely to matter to us). There was an instance of use of a "global" that was not intended to be such. This was spotted by moving the core script-like functionality into a function, which avoided adding names to the global namespace. The script is also renamed to conform to python module-naming conventions. All warnings and errors are resolved, except the overly broad catching of Exception, which is explicitly silenced. Add a workflow for running the HelloWorld example in CI as a simple sanity check on run-example functionality.
2022-03-15 17:15:26 -04:00
debug_and_run "python3 \"${INFRASTRUCTURE_DIR}/run_example.py\" $*"
Reference in New Issue Copy Permalink