This repository contains the Open Water Foundation TSTool Amazon Web Services (AWS) plugin. This plugin can be installed to enable commands that integrate TSTool with AWS.
TSTool is part of Colorado's Decision Support Systems (CDSS). See the following online resources:
See the following sections in this page:
The following are the main folders and files in this repository, listed alphabetically.
C:\Users\user\ User's files on windows.
/c/Users/user/ User's files in Git bash.
cdss-dev/ Recommended folder for CDSS product development.
TSTool/ Recommended folder for TSTool development.
git-repos/ Recommended folder for TSTool product repositories.
owf-tstool-aws-plugin/ Repository working files.
.gitattributes Git configuration file for repository.
.gitignore Git configuration file for repository.
build-util/ Utilities used in the build process.
dist/ Folder containing software installers.
doc-user-mkdocs-project/ MkDocs project for user documentation.
owf-tstool-aws-plugin/ Maven project source code and supporting files.
.classpath Eclipse configuration file.
.project Eclipse configuration file.
.settings/ Eclipse settings for developer.
src/ Plugin source code.
target/ Compiled code.
README.md This file.
test/ End to end tests for commands.
This project is configured using Maven, which manages third-party dependencies, such as AWS packages.
Additionally, the following table lists Eclipse project dependencies that are not managed by Maven.
Repository | Description |
---|---|
cdss-lib-common-java |
Library of core utility code used by multiple TSTool repositories (projects). |
cdss-lib-processor-ts-java |
Library containing processor code for TSTool commands. |
This section explains how to add the TSTool AWS plugin to the TSTool core development environment.
C:\Program Files\Maven\apache-maven-3.8.6
(or similar).cdss-dev/TSTool/git-repos/owf-tstool-aws-plugin/owf-tstool-aws-plugin
folder
and Select Folder.
The folders are redundant because one is for the repository and one is the Maven project.pom.xml
file selected for this repository.
Press Finish.owf-tstool-aws-plugin
in Package Explorer or Project Explorer
and select Build Path / Configure Build Path.
The Jar file and Maven libraries will already be selected from the project configuration file.
In the Projects tab, the project dependencies should also be configured.build-util/0-create-plugin-jar.bash
script after the initial compile
and other code changes, which will build and copy the plugin Jar file to the user's TSTool files.
Then when TSTool is run from Eclipse, the plugins will be found in the normal location and will be loaded for testing.Plugin Eclipse projects are not part of the "built in" TSTool code. During development, plugins are handled as follows:
owf-tstool-aws-plugin
repository is added as a Maven project.cdss-lib-common-java
.build-util/0-create-plugin-jar.bash
script to create the
plugin jar
file in the user's .tstool/NN/plugins
folder in order to test the plugin.owf-tstool-aws-plugin/src/main/resources/META-INF/MANIFEST.MF
file to provide information about the plugin to TSTool,
including the list of plugin commands and third-party jar
files that are used by the plugin.The plugin is currently distributed on Windows using a zip file, using the following procedure:
src/main/java/owf-tstool-aws-plugin/org/openwaterfoundation/tstool/plugin/aws/PluginMeta.java
source file.index.md
file to be consistent with the version.doc-user-mkdocs-project/build-util/copy-to-owf-amazon-s3.bash
.build-util/0-create-plugin-jar.bash
script to create the plugin jar file.
Confirm that there is only one jar file version in the plugins folder
(the script will warn if more than one java file exists).build-util/1-create-installer.bash
script to create the installer.build-util/2-copy-to-owf-amazon-s3.bash
script.
This will upload the local zip file to OWF's S3 bucket.
The script prompts as to whether to update the product landing page index.html
.build-util/3-create-s3-index.bash
script to create the plugin landing page.Contributions to this project can be submitted using the following options:
See also the OpenCDSS / TSTool protocols
Copyright Open Water Foundation.
The software is licensed under GPL v3+. See the LICENSE.md file.
Steve Malers, @smalers, steve.malers@openwaterfoundation.org.