Merge pull request #7 from Volt-MX-GO/MXGO-1176

MXGO-1176

Author: paulswithers

CHANGELOG.md

@@ -0,0 +1,17 @@
+# CHANGELOG
+
+## [1.0.0] - 2023-09-21
+
+- Updating atlas.json
+- Updating .bss to .vss
+- Updated API doc
+- Adding details about dependency management
+
+## [1.0.0 RC2] - 2023-04-21
+
+- Renaming from bali-unit to VoltScriptTesting
+- Updated API doc
+
+## [1.0.0 RC1] - 2023-02-01
+
+- Initial release

CODE_OF_CONDUCT.md

@@ -0,0 +1,51 @@
+# Contributor Covenant Code of Conduct
+
+Projects should foster a positive environment, to ensure active and pleasant participation for all. This is wording for a contributor covenant, amended from [Contributor Covenant 2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/).
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+-> Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others’ private information, such as a physical or email address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the HCL Open Source Project Officer, who is responsible for enforcement, at [ospo.hclsoftware@hcl.com](mailto:ospo.hclsoftware@hcl.com). All complaints will be reviewed and investigated promptly and fairly. The HCL Open Source Project Office is obligated to respect the privacy and security of the reporter of any incident. Details of enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by the HCL Open Source Project Office.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at <a href="https://www.contributor-covenant.org/version/2/0/code_of_conduct.html">https://www.contributor-covenant.org/version/2/0/code_of_conduct.html</a>.
+
+Community Impact Guidelines were inspired by Mozilla’s code of conduct enforcement ladder.
+
+For answers to common questions about this code of conduct, see the FAQ at <a href="https://www.contributor-covenant.org/faq">https://www.contributor-covenant.org/faq</a>.

CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing Guidelines
+
+## Contributor roles
+
+Open source should not be just about writing code. A good open source project also needs:
+
+- Documentation writers
+- Testers
+- Tutorial writers
+- Evangelists
+- Automation builders
+
+If you want to get involved in a role (including ones we may have missed!) reach out to one of the committers.
+
+## Working on issues
+
+- Ensure there is a GitHub issue for any bug before submitting a PR.
+- Enhancements should be discussed and a feature request issue created, before starting work on it.
+- Fork and raise a PR for work.
+- Add tests for any enhancements.
+- Ensure documentation is updated accordingly, including adding unit test reports.
+- Ensure API docs are updated (speak to an HCL-ite if required).
+- Ensure changelog is updated.
+
+## Development Environment
+
+- Develop code with Visual Studio Code and VoltScript extensions, see https://help.hcltechsw.com/docs/voltscript/early-access/howto/writing/index.html.
+- Documentation uses Material for MKDocs framework:
+    - Write documentation in the relevant area of the docs directory.
+    - Preview documentation using MKDocs, either [locally installed with relevant plugins](https://squidfunk.github.io/mkdocs-material/getting-started/) or using the [MKDocs HCL Container Image](https://github.com/HCL-TECH-SOFTWARE/hcl-mkdocs-build-image)
+
+## PRs
+
+- When ready, complete a PR and submit.
+- Review the requirements for submitting a PR, for example writing test and updating documentation.

README.md

@@ -2,6 +2,46 @@
 
 VoltScript Testing Framework is a framework for testing code written using VoltScript, the evolution of LotusScript delivered as part of HCL Volt MX Go. The framework can also be used for LotusScript, with modifications (see below on new language functions used). There are deliberately no dependencies on any LSXs (e.g nlsxbe.dll). None should be added, it will make it dependent on a particular implementation. Create separate classes derived from CustomTester to test individual LSXs or custom classes.
 
+## Using dependency management
+
+Dependency management is available in the documentation for each project, but also aggregated here:
+
+### Authentication
+
+You'll need a [Personal Access Token](../howto/writing/archipelago.md#github-personal-access-token) to use GitHub REST APIs. You'll then need to add this to the JSON object in your [atlas-settings.json](../howto/writing/archipelago.md#atlas-settingsjson), in the .vss directory of your user home directory:
+
+```json
+    "hcl-github": {
+        "type": "github",
+        "token": "${env.TOKEN}"
+    }
+```
+
+### Repository
+
+You'll need to add to your **repositories** object in the atlas.json of your project:
+
+```json
+        {
+            "id": "hcl-github",
+            "type": "github",
+            "url": "https://api.github.com/HCL-TECH-SOFTWARE"
+        }
+```
+
+### Dependency
+
+You'll need the relevant dependency to add to your **dependencies** or **testDependencies** object in the atlas.json of your project:
+
+```json
+        {
+            "library": "voltscript-testing",
+            "version": "1.0.0",
+            "module": "VoltScriptTesting.vss",
+            "repository": "hcl-github"
+        }
+```
+
 ## Writing VoltScript Tests
 
 See [Writing Units Tests](/docs/howto/writingtests.md).
@@ -10,17 +50,18 @@ See [Writing Units Tests](/docs/howto/writingtests.md).
 
 Obviously the code runs certain core language functions. These are documented in [Core Functions](/docs/references/CoreFunctions.md).
 
-There are three new VoltScript language functions used - Try/Catch/Finally and GetThreadInfo(12) in TestRunner.bss and ++/-- in SampleBeforeAfterTester.bss.
+There are three new VoltScript language functions used - Try/Catch/Finally and GetThreadInfo(12) in TestRunner.vss and ++/-- in SampleBeforeAfterTester.vss.
+
+## Contributing
 
-### Documentation
+See [CONTRIBUTING.md](contributing.md).
 
-Documentation uses [Material for MKDocs](https://squidfunk.github.io/mkdocs-material/getting-started/#installation), which uses Markdown files in the docs directory. The [awesome-pages](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin) is the only additional plugin in use.
+## Code of Conduct
 
-This can be previewed using a Docker container or locally. To run locally, follow the [Material for MKDocs documentation](https://squidfunk.github.io/mkdocs-material/getting-started/#with-pip) and the steps to install awesome-pages plugin on their GitHub.
+See [CODE_OF_CONDUCT.md](code_of_conduct.md).
 
-To use with Docker, a Dockerfile has been included. In a terminal, navigate to the docker directory. Issue the command `docker build -t mkdocs-plus .` This creates a Docker image based on MKDocs Material image, adding the additional plugin. If you are using a M1 Mac, a different starting image will be needed, `ghcr.io/afritzler/mkdocs-material`, see https://github.com/afritzler/mkdocs-material.
+## Issues and discussions
 
-Once the Docker container is created, it can be started as a temporary container by:
+Let's chat on [OpenNTF Discord](https://openntf.org/discord).
 
-1. Open a terminal and navigate to this directory.
-2. Issue the command `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs mkdocs-plus`. On Windows, `${PWD}` maps to the current directory for PowerShell, `%cd%` for a normal Windows cmd prompt. Other MKDocs commands can be appended, as required - see MKDocs documentation for more details.
+For long-running discussions, use Discussions area in GitHub. For bugs and feature requests **specific to VoltScript Testing Framework** use, Issues area.

atlas.json

@@ -13,12 +13,14 @@
     "sourceDir": "src",
     "testDir": "test",
     "libsDir": "",
-    "lsxsDir": "",
+    "vsesDir": "",
     "mainScripts": [
-        "VoltScriptTesting.bss"
+        "VoltScriptTesting.vss"
     ],
     "unitTestScripts": [
-        "BasicTester.bss"
+        "BasicTester.vss",
+        "SampleBeforeAftertester.vss",
+        "SampleCustomTester.vss"
     ],
     "integrationTestScripts": [
 
@@ -31,6 +33,6 @@
     "testDependencies": [
 
     ],
-    "dependenciesLSX": {
+    "vseDependencies": {
     }
 }

docker/Dockerfile

@@ -19,7 +19,7 @@
 %END REM
 Option Public
 Option Declare
-Use "VoltScriptTesting"
+Use "../libs/VoltScriptTesting"
 Sub Initialize
 	Dim testRunner As TestRunner
 	Dim results As Integer

…cs/assets/example_code/TestBootstrap.bss …cs/assets/example_code/TestBootstrap.vssdocs/assets/example_code/TestBootstrap.bss renamed to docs/assets/example_code/TestBootstrap.vss docs/assets/example_code/TestBootstrap.bss renamed to docs/assets/example_code/TestBootstrap.vss

@@ -1,5 +1,6 @@
 nav:
     - index.md
+    - archipelago.md
     - Standalone.md
     - Aggregate test suites: TestRunner.md
     - writingtests.md

docs/howto/.pages

@@ -0,0 +1,42 @@
+# Using dependency management
+
+!!!info
+    For generic how-to information about VoltScript Dependency Management, see [VoltScript documentation](https://help.hcltechsw.com/docs/voltscript/early-access/howto/writing/archipelago.html).
+
+Dependency management is available in the documentation for each project, but also aggregated here:
+
+## Authentication
+
+You'll need a [Personal Access Token](https://help.hcltechsw.com/docs/voltscript/early-access/howto/writing/archipelago.md#github-personal-access-token) to use GitHub REST APIs. You'll then need to add this to the JSON object in your [atlas-settings.json](https://help.hcltechsw.com/docs/voltscript/early-access/howto/writing/archipelago.md#atlas-settingsjson), in the .vss directory of your user home directory:
+
+```json
+    "hcl-github": {
+        "type": "github",
+        "token": "${env.TOKEN}"
+    }
+```
+
+## Repository
+
+You'll need to add to your **repositories** object in the atlas.json of your project:
+
+```json
+        {
+            "id": "hcl-github",
+            "type": "github",
+            "url": "https://api.github.com/HCL-TECH-SOFTWARE"
+        }
+```
+
+## Dependency
+
+You'll need the relevant dependency to add to your **dependencies** or **testDependencies** object in the atlas.json of your project:
+
+```json
+        {
+            "library": "voltscript-testing",
+            "version": "1.0.0",
+            "module": "VoltScriptTesting.vss",
+            "repository": "hcl-github"
+        }
+```

docs/howto/archipelago.md

@@ -13,6 +13,11 @@ There are no dependencies on any LotusScript Extensions (LSX), such as `nlsxbe.d
 
 For the latest release information about VoltScript Testing, see [What's new](references/whatsnew.md)
 
+---
+## Using via dependency management
+
+For using with dependency management, see [Using dependency management](howto/archipelago.md)
+
 ---
 ## How the documentation is organized