MONGOSH-248 - Run java-shell tests as part of the test suite (#388)

Author: addaleax

packages/java-shell/package-lock.json

@@ -12,7 +12,8 @@
   },
   "scripts": {
     "browserify-shell-api": "browserify src/main/js/all.js -o src/main/resources/js/all-standalone.js -dv",
-    "test-ci": "npm run test"
+    "test": "mocha -r \"../../scripts/import-expansions.js\" --timeout 60000 --colors -r ts-node/register \"./src/test/js/run-tests.ts\"",
+    "test-ci": "node ../../scripts/run-if-platform.js linux npm run test"
   },
   "devDependencies": {
     "browserify": "latest"

packages/java-shell/package.json

@@ -0,0 +1,62 @@
+'use strict';
+import child_process from 'child_process';
+import fs from 'fs';
+import path from 'path';
+import { startTestServer } from '../../../../../testing/integration-testing-hooks';
+
+const port = '27019';
+const authlessUri = `mongodb://localhost:${port}`;
+const uri = `mongodb://admin:admin@localhost:${port}`;
+
+describe('java-shell tests', function() {
+  this.timeout(300_000);
+  const connectionString = startTestServer();
+  const uriFile = path.resolve(__dirname, '..', 'resources', 'URI.txt');
+  const packageRoot = path.resolve(__dirname, '..', '..', '..') + '/';
+  let origUriFileContent;
+
+  before((done) => {
+    // We can probably turn this into execSync once
+    // https://jira.mongodb.org/browse/MONGOSH-401 is fixed
+    const mongosh = child_process.spawn(
+      process.execPath,
+      [ path.resolve(packageRoot, '..', 'cli-repl', 'bin', 'mongosh.js'), connectionString ],
+      { stdio: [ 'pipe', 'pipe', 'inherit' ], env: { ...process.env, NO_COLOR: '1' } });
+    let out = '';
+    let wroteCreateUser = false;
+    let isDone = false;
+    mongosh.stdout.setEncoding('utf8').on('data', (chunk) => {
+      out += chunk;
+      process.stderr.write(chunk);
+      if (out.includes('> ') && !wroteCreateUser) {
+        wroteCreateUser = true;
+        mongosh.stdin.write(`
+          use admin;
+          db.createUser({ user: "admin", pwd: "admin", roles: ["root"]});
+        `);
+      }
+      if ((out.includes('{ ok: 1 }') ||
+           out.includes('User "admin@admin" already exists')) && !isDone) {
+        isDone = true;
+        mongosh.kill();
+        origUriFileContent = fs.readFileSync(uriFile);
+        fs.writeFileSync(uriFile,
+          connectionString.replace('mongodb://', 'mongodb://admin:admin@'));
+        done();
+      }
+    });
+  });
+
+  after(() => {
+    fs.writeFileSync(uriFile, origUriFileContent);
+  });
+
+  it('passes the JavaShell tests', () => {
+    if (process.platform !== 'win32') {
+      child_process.execSync('./gradlew test --info', { stdio: 'inherit', cwd: packageRoot });
+    } else {
+      child_process.execSync('.\\gradlew.bat test --info', { stdio: 'inherit', cwd: packageRoot });
+    }
+  });
+});
+

packages/java-shell/src/test/js/run-tests.ts

@@ -143,12 +143,20 @@ private fun withDb(shell: MongoShell, name: String?, block: () -> Unit) {
 
 @Throws(IOException::class)
 private fun compare(testDataPath: String, name: String, actual: String) {
-    val expectedFile = File("$testDataPath/$name.expected.txt")
+    var expectedFile = File("$testDataPath/$name.expected.txt")
     if (!expectedFile.exists()) {
         assertTrue(expectedFile.createNewFile())
         expectedFile.writeText(actual.trim())
         fail("Created output file $expectedFile")
     } else {
+        for (counter in 1..10) {
+            if (expectedFile.readText().trim() == actual.trim()) break
+
+            val alternativeFile = File("$testDataPath/$name.expected.$counter.txt")
+            if (alternativeFile.exists()) {
+                expectedFile = alternativeFile
+            }
+        }
         assertEquals(expectedFile.readText().trim(), actual.trim())
     }
 }

packages/java-shell/src/test/kotlin/com/mongodb/mongosh/util.kt

@@ -0,0 +1 @@
+com.mongodb.MongoCommandException: Command failed with error 2 (BadValue): 'cursor.batchSize must not be negative' on server localhost:27018. The full response is {"ok": 0.0, "errmsg": "cursor.batchSize must not be negative", "code": 2, "codeName": "BadValue"}

packages/java-shell/src/test/resources/collection/aggregateWithNegativeBatchSize.expected.1.txt

@@ -0,0 +1,2 @@
+[ "category_1" ]
+[ { "v": 2, "key": { "_id": 1 }, "name": "_id_" }, { "v": 2, "key": { "category": 1 }, "name": "category_1", "collation": { "locale": "fr", "caseLevel": false, "caseFirst": "off", "strength": 3, "numericOrdering": false, "alternate": "non-ignorable", "maxVariable": "punct", "normalization": false, "backwards": false, "version": "57.1" } } ]

packages/java-shell/src/test/resources/collection/createIndex.expected.1.txt

@@ -0,0 +1 @@
+[ { "v": 2, "key": { "_id": 1 }, "name": "_id_" } ]

packages/java-shell/src/test/resources/collection/dropIndex.expected.1.txt

@@ -0,0 +1 @@
+[ { "v": 2, "key": { "_id": 1 }, "name": "_id_" } ]

packages/java-shell/src/test/resources/collection/dropIndexes.expected.1.txt

@@ -0,0 +1 @@
+[ { "v": 2, "key": { "_id": 1 }, "name": "_id_" } ]

packages/java-shell/src/test/resources/collection/getIndexes.expected.1.txt

@@ -0,0 +1,2 @@
+[ "category_1" ]
+com.mongodb.MongoBulkWriteException: Bulk write operation error on server localhost:27018. Write errors: [BulkWriteError{index=0, code=11000, message='E11000 duplicate key error collection: admin.coll index: category_1 dup key: { category: "cat1" }', details={}}].