cisco-open / stated Goto Github PK

Problem Statement

To enable local unit testing, a test file needs to import a template that it is testing

Proposed Solution

Allow import to load a local file based on a relative location of the caller

Description

There are many ways to express data dependencies that aren't discoverable by the DAG building process.

Actual Behavior

One example

> .init -f "test.json"

{
  "a": "❌",
  "b": [
    "/${a}"
  ],
  "c$": "$lookup('a')"
}

> .out

{
  "a": "❌",
  "b": [
    "❌"
  ],
  "c$": "❌"
}

> .set /a "✅"

{
  "a": "✅",
  "b": [
    "✅"
  ],
  "c$": "❌" // 👈 Actual
}

Expected Behavior

.set /a "✅" should result in "c$": "✅".

> .set /a "✅"

{
  "a": "✅",
  "b": [
    "✅"
  ],
  "c$": "✅" // 👈 Expected
}

Affected Version

0.0.10, 0.0.29

Steps to Reproduce

1. Clone the repo at latest (1452aa6).
2. Change // to # in .npmrc. (Otherwise next step fails.)
3. Run yarn.
4. Create test.json with above snippet.
5. Run yarn stated.
6. Enter above commands (.init -f "test.json", .out, .set /a "✅").

Checklist

• I have read the contributing guidelines
• I have verified this does not duplicate an existing issue

Environment

Problem Statement

Local testing needs access to shared functions which are accessible via a REST API that requires authorization

Proposed Solution

Add OIDC/OAuth2 support to import function, via a new 'auth' object argument which can have a structure like

• authority (string): The URL of the OIDC/OAuth2 provider, which will be used to get its metadata i.e. https://snoopy.observe.appdynamics.com/auth/8e1716f8-d79e-4a64-a91d-d1589f5fe94d/default. .well-known/openid-configuration will be appended to this URL as per OIDC specification
• client_id (string): Your client application's identifier as registered with the OIDC/OAuth2 provider
• client_secret (string): Your client application's secret as registered with the OIDC/OAuth2 provider
• scope (string, default: 'openid'): The scope being requested from the OIDC/OAuth2 provider

Description

.out on invalid path crashes REPL

Expected Behavior

REPL does not crash, and prints an error instead

Actual Behavior

REPL crashes with

null
file:///usr/local/lib/node_modules/stated-js/dist/src/StatedREPL.js:120
if (!result.toString().startsWith("Started tailing...") || this.tookOverIO(cliCoreMethodName)) {
^

TypeError: Cannot read properties of null (reading 'toString')
at StatedREPL.cli (file:///usr/local/lib/node_modules/stated-js/dist/src/StatedREPL.js:120:21)
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
at async REPLServer.action (file:///usr/local/lib/node_modules/stated-js/dist/src/StatedREPL.js:70:21)

Steps to Reproduce

1. .init < your template >
2. .out < invalid path >

Problem Statement

In order to enable unit testing, each failed test case needs to record an error in some global report, while continuing the execution of all the tests in a suite. That report needs to be returned in the end of test case execution

Proposed Solution

Add a new function, i.e. reportError(string name), which appends a new error to the report.
.out should return the report if there are any errors in it. This could be an option triggered by an argument