Skip to content

Commit

Permalink
Merge pull request #18 from gjsjohnmurray/prepare-0.2.2
Browse files Browse the repository at this point in the history
Prepare 0.2.2
  • Loading branch information
gjsjohnmurray authored Jun 10, 2023
2 parents 33d1335 + 644c056 commit 7fea0ac
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 39 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 0.2.2 (10-Jun-2023)
* Handle method names containing numerics.
* Support workspaces that don't use Server Manager.

## 0.2.1 (08-Jun-2023)
* Discover client-side tests when using `objectscript.conn.docker-compose` settings (#10)

Expand Down
41 changes: 2 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,43 +34,7 @@ In order to support topologies in which client-side-managed test classes have to
## Workspace Preparations

1. Ensure your VS Code workspace specifies its server connection(s) by referencing server(s) in the `intersystems.servers` configuration object which InterSystems Server Manager maintains. For example, assuming a server named `iris231` has been defined:

- For the **client-side** paradigm (in `settings.json`, or in `"settings"` object in `xxx.code-workspace` file):
```json
"objectscript.conn": {
"server": "iris231",
"ns": "APP",
"active": true
},
```

- For the **server-side** paradigm (in `xxx.code-workspace` file):
```json
"folders": [
{
"name": "iris231:APP-ISFS",
"uri": "isfs://iris231:app-isfs/?mapped=0"
}
],
```

> We recommend setting the `username` property of the server definition object, and using Server Manager's secure password storage feature to hold that user's password.

> If you are editing client-side and using the `docker-compose` object within your `objectscript.conn` settings to handle dynamic assignment of the web server port at the host end, omit the `server` property. You will have to put credentials in the settings as plaintext, so this should **only** be done with well-known 'standard' ones such as shown as an example below:
```json
"objectscript.conn" :{
"ns": "APP",
"username": "_SYSTEM",
"password": "SYS",
"docker-compose": {
"service": "iris",
"internalPort": 52773
},
"active": true
},
```
2. For a workspace using client-side editing, test classes are sought in `.cls` files under the `internal/testing/unit_tests` subfolder, using the conventional layout of one additional subfolder per package-name element. If your test classes are located elsewhere, use the `intersystems.testingManager.client.relativeTestRoot` setting to point there.
For a workspace using client-side editing, test classes are by default sought in `.cls` files under the `internal/testing/unit_tests` subfolder, using the conventional layout of one additional subfolder per package-name element. If your test classes are located elsewhere, use the `intersystems.testingManager.client.relativeTestRoot` setting to point there.

> By setting this at the workspace level you can have different file layouts for different projects.
Expand Down Expand Up @@ -103,9 +67,8 @@ Hovering on a run's folder reveals an action button which launches %UnitTest's o

This extension is a preview and has some known limitations:

- The extension uses server-side REST support for debugging even when tests are not being debugged. That support is broken in InterSystems IRIS 2021.1.3, and maybe also in earlier 2021.1.x versions.
- The extension uses server-side REST support for debugging even when tests are not being debugged. Debug support is broken in InterSystems IRIS 2021.1.3, and maybe also in earlier 2021.1.x versions. Either upgrade to a later version or request an ad-hoc patch from InterSystems.
- In client-side mode test-run results don't update the testing icons in the editor gutter or the Local Tests tree in Testing view. Workaround is to view them under the Recent History tree.
- Debugging tests in client-side mode has issues arising from how your workspace stores your test classes outside the source tree of the classes they are testing. Please see the extension's repository (link below) and add new issues if you experience problems not already logged there.
- The extension has only been tested with InterSystems IRIS instances that use the English locale. Its technique for parsing the output from %UnitTest is likely to fail with other locales.
- The `/autoload` feature of %UnitTest is not supported. This is only relevant to client-side mode.
- The loading and deleting of unit test classes which occurs when using client-side mode will raise corresponding events on any source control class that the target namespace may have been configured to use.
Expand Down

0 comments on commit 7fea0ac

Please sign in to comment.