retold 4.0.3 → 4.0.4

package/docs/testing.md

@@ -0,0 +1,122 @@
+# Testing
+
+Retold modules use [Mocha](https://mochajs.org/) in TDD style with [Chai](https://www.chaijs.com/) assertions. Each module has its own test suite that runs independently.
+
+## Running Module Tests
+
+From any module directory:
+
+```bash
+npm test                  # Run the test suite
+npm run coverage          # Run with code coverage (if available)
+```
+
+## Database Tests (Meadow)
+
+The Meadow data access modules (`meadow`, `meadow-connection-mysql`, `meadow-connection-mssql`) require live database servers for their full test suites. Docker scripts in `modules/meadow/meadow/scripts/` manage disposable test containers on non-standard ports so they won't conflict with local database servers.
+
+### Prerequisites
+
+- [Docker](https://www.docker.com/) installed and running
+
+### Ports
+
+| Database | Container Name | Host Port | Standard Port |
+|----------|---------------|-----------|---------------|
+| MySQL 8.0 | `meadow-mysql-test` | **33306** | 3306 |
+| MSSQL 2022 | `meadow-mssql-test` | **31433** | 1433 |
+
+### Quick Start
+
+From `modules/meadow/meadow/`:
+
+```bash
+# Start MySQL, seed the bookstore database, and run MySQL tests
+npm run test-mysql
+
+# Start MSSQL and run MSSQL tests
+npm run test-mssql
+
+# Start both and run the full suite
+npm run test-all-providers
+```
+
+### Managing Containers
+
+```bash
+# MySQL
+npm run docker-mysql-start     # Start container + seed data
+npm run docker-mysql-stop      # Stop and remove container
+npm run docker-mysql-status    # Check if container is running
+
+# MSSQL
+npm run docker-mssql-start
+npm run docker-mssql-stop
+npm run docker-mssql-status
+
+# Both
+npm run docker-cleanup         # Stop and remove both containers
+```
+
+Or call the scripts directly:
+
+```bash
+./scripts/mysql-test-db.sh start
+./scripts/mssql-test-db.sh start
+./scripts/meadow-test-cleanup.sh
+```
+
+### What the Scripts Do
+
+**MySQL** (`mysql-test-db.sh start`):
+1. Pulls and starts a `mysql:8.0` container on port 33306
+2. Waits for MySQL to accept connections
+3. Creates the `bookstore` database (via Docker `MYSQL_DATABASE` env)
+4. Loads the bookstore schema (Book, Author, BookAuthorJoin, BookPrice, Review tables)
+5. Seeds 20 books and 21 authors from the Retold test dataset
+
+**MSSQL** (`mssql-test-db.sh start`):
+1. Pulls and starts an `mcr.microsoft.com/mssql/server:2022-latest` container on port 31433
+2. Waits for MSSQL to accept connections
+3. Creates the `bookstore` database via `sqlcmd`
+
+The MSSQL tests create their own tables in `suiteSetup`, so no additional schema loading is needed.
+
+### Connection Details
+
+**MySQL:**
+- Host: `127.0.0.1`
+- Port: `33306`
+- User: `root`
+- Password: `123456789`
+- Database: `bookstore`
+
+**MSSQL:**
+- Host: `127.0.0.1`
+- Port: `31433`
+- User: `sa`
+- Password: `1234567890abc.`
+- Database: `bookstore`
+
+### Running Individual Module Tests
+
+Once the containers are running, you can also run the connection module tests directly:
+
+```bash
+# meadow-connection-mysql (requires MySQL container)
+cd modules/meadow/meadow-connection-mysql && npm test
+
+# meadow-connection-mssql (requires MSSQL container)
+cd modules/meadow/meadow-connection-mssql && npm test
+```
+
+### Cleanup
+
+When you're done testing, remove the containers:
+
+```bash
+cd modules/meadow/meadow
+npm run docker-cleanup
+```
+
+This stops and removes both the MySQL and MSSQL test containers. The database data is ephemeral and does not persist between container restarts.

package/modules/Include-Retold-Module-List.sh

@@ -6,7 +6,7 @@ repositoriesFable=("fable" "fable-log" "fable-settings" "fable-uuid" "fable-serv
 
 repositoriesMeadow=("stricture" "foxhound" "bibliograph" "meadow" "parime" "meadow-endpoints" "meadow-connection-mysql" "meadow-connection-mssql" "meadow-connection-sqlite" "retold-data-service" "retold-harness" "meadow-integration")
 
-repositoriesOrator=("orator" "orator-serviceserver-restify" "orator-static-server" "orator-http-proxy" "tidings" "orator-endpoint" "orator-conversion")
+repositoriesOrator=("orator" "orator-serviceserver-restify" "orator-static-server" "orator-http-proxy" "tidings" "orator-conversion")
 
 repositoriesPict=("pict" "pict-template" "pict-view" "pict-provider" "pict-application" "pict-panel" "pict-nonlinearconfig" "pict-section-flow" "pict-docuserve" "cryptbrau" "informary" "pict-service-commandlineutility" "pict-section-recordset" "pict-section-content" "pict-section-form" "pict-section-tuigrid" "pict-router" "pict-serviceproviderbase" "pict-terminalui")
 

package/package.json

@@ -1,8 +1,11 @@
 {
     "name": "retold",
-    "version": "4.0.3",
+    "version": "4.0.4",
     "description": "The pict and fable node ecosystem.",
     "main": "source/Retold.cjs",
+    "bin": {
+        "manager": "./source/retold-manager/retold-manager.js"
+    },
     "scripts": {
         "start": "node source/Retold.cjs",
         "coverage": "./node_modules/.bin/nyc --reporter=lcov --reporter=text-lcov ./node_modules/mocha/bin/_mocha -- -u tdd -R spec",
@@ -25,8 +28,8 @@
     },
     "homepage": "https://github.com/stevenvelozo/retold",
     "devDependencies": {
-        "indoctrinate": "^1.0.4",
-        "pict-docuserve": "^0.0.15",
-        "quackage": "^1.0.48"
+        "indoctrinate": "^1.0.7",
+        "pict-docuserve": "^0.0.16",
+        "quackage": "^1.0.51"
     }
 }

package/source/retold-manager/package.json

@@ -0,0 +1,23 @@
+{
+	"name": "retold-manager",
+	"version": "0.0.1",
+	"description": "Terminal UI manager for retold module repositories",
+	"main": "retold-manager.js",
+	"bin": {
+		"retold-manager": "./retold-manager.js"
+	},
+	"scripts": {
+		"start": "node retold-manager.js",
+		"test": "echo \"No tests yet\" && exit 0"
+	},
+	"license": "MIT",
+	"dependencies": {
+		"blessed": "^0.1.81",
+		"fable": "^3.0.232",
+		"fable-serviceproviderbase": "^3.0.16",
+		"pict": "^1.0.345",
+		"pict-application": "^1.0.28",
+		"pict-terminalui": "^0.0.2",
+		"pict-view": "^1.0.64"
+	}
+}

package/source/retold-manager/retold-manager.js

@@ -0,0 +1,65 @@
+#!/usr/bin/env node
+/**
+ * Retold Manager -- Terminal UI for Module Management
+ *
+ * A pict-terminalui application for browsing the retold module suite
+ * and running common operations (install, test, build, version, diff).
+ *
+ * Run:   node retold-manager.js
+ * Quit:  Ctrl-C
+ */
+
+// Suppress blessed's Setulc stderr noise before anything loads
+const _origStderrWrite = process.stderr.write;
+process.stderr.write = function (pChunk)
+{
+	if (typeof pChunk === 'string' && pChunk.indexOf('Setulc') !== -1)
+	{
+		return true;
+	}
+	return _origStderrWrite.apply(process.stderr, arguments);
+};
+
+const libPict = require('pict');
+const libPictApplication = require('pict-application');
+
+const libRetoldManagerApp = require('./source/Retold-Manager-App.js');
+
+// ─────────────────────────────────────────────
+//  Bootstrap
+// ─────────────────────────────────────────────
+let _Pict = new libPict(
+	{
+		Product: 'RetoldManager',
+		LogNoisiness: 0,
+		// Silence the default console log stream so it doesn't corrupt the
+		// blessed TUI.  File logging is added dynamically via [l] toggle.
+		LogStreams:
+		[
+			{
+				loggertype: 'console',
+				streamtype: 'console',
+				level: 'fatal',
+				outputloglinestoconsole: false,
+				outputobjectstoconsole: false,
+			}
+		],
+	});
+
+let _App = _Pict.addApplication('RetoldManager',
+	{
+		Name: 'RetoldManager',
+		MainViewportViewIdentifier: 'TUI-Layout',
+		AutoRenderMainViewportViewAfterInitialize: false,
+		AutoSolveAfterInitialize: false,
+	}, libRetoldManagerApp);
+
+_App.initializeAsync(
+	(pError) =>
+	{
+		if (pError)
+		{
+			console.error('Application initialization failed:', pError);
+			process.exit(1);
+		}
+	});