chore: use async await in extension tests (#446)

Author: Anemy

src/test/suite/editors/collectionDocumentsProvider.test.ts

@@ -43,7 +43,7 @@ suite('Collection Documents Provider Test Suite', () => {
     sinon.restore();
   });
 
-  test('provideTextDocumentContent parses uri and return documents in the form of a string from a find call', (done) => {
+  test('provideTextDocumentContent parses uri and return documents in the form of a string from a find call', async () => {
     const mockActiveDataService = {
       find: (namespace, filter, options, callback): void => {
         assert(
@@ -85,19 +85,15 @@ suite('Collection Documents Provider Test Suite', () => {
       `scheme:Results: filename.json?namespace=my-favorite-fruit-is.pineapple&operationId=${operationId}`
     );
 
-    testCollectionViewProvider
-      .provideTextDocumentContent(uri)
-      .then((documents) => {
-        assert(
-          documents.includes('Declaration of Independence'),
-          `Expected provideTextDocumentContent to return documents string, found ${documents}`
-        );
-        done();
-      })
-      .catch(done);
+    const documents =
+      await testCollectionViewProvider.provideTextDocumentContent(uri);
+    assert(
+      documents.includes('Declaration of Independence'),
+      `Expected provideTextDocumentContent to return documents string, found ${documents}`
+    );
   });
 
-  test('provideTextDocumentContent returns a ejson.stringify string', (done) => {
+  test('provideTextDocumentContent returns a ejson.stringify string', async () => {
     const mockDocuments = [
       {
         _id: 'first_id',
@@ -139,19 +135,16 @@ suite('Collection Documents Provider Test Suite', () => {
       `scheme:Results: filename.json?namespace=test.test&operationId=${operationId}`
     );
 
-    testCollectionViewProvider
-      .provideTextDocumentContent(uri)
-      .then((documents) => {
-        assert(
-          documents === mockDocumentsAsJsonString,
-          `Expected provideTextDocumentContent to return ejson stringified string, found ${documents}`
-        );
-        done();
-      })
-      .catch(done);
+    const documents =
+      await testCollectionViewProvider.provideTextDocumentContent(uri);
+    assert.strictEqual(
+      documents,
+      mockDocumentsAsJsonString,
+      `Expected provideTextDocumentContent to return ejson stringified string, found ${documents}`
+    );
   });
 
-  test('provideTextDocumentContent sets hasMoreDocumentsToShow to false when there arent more documents', (done) => {
+  test('provideTextDocumentContent sets hasMoreDocumentsToShow to false when there arent more documents', async () => {
     const mockActiveDataService = {
       find: (namespace, filter, options, callback): void => {
         return callback(null, [{ field: 'Apollo' }, { field: 'Gemini ' }]);
@@ -185,28 +178,21 @@ suite('Collection Documents Provider Test Suite', () => {
       `scheme:Results: filename.json?namespace=vostok.mercury&operationId=${operationId}`
     );
 
-    void testCollectionViewProvider.provideTextDocumentContent(uri).then(() => {
-      assert(
-        testQueryStore.operations[operationId].hasMoreDocumentsToShow === false,
-        'Expected not to have more documents to show.'
-      );
-
-      // Reset and test inverse.
-      testQueryStore.operations[operationId].currentLimit = 2;
-      testQueryStore.operations[operationId].hasMoreDocumentsToShow = true;
+    await testCollectionViewProvider.provideTextDocumentContent(uri);
+    assert(
+      testQueryStore.operations[operationId].hasMoreDocumentsToShow === false,
+      'Expected not to have more documents to show.'
+    );
 
-      testCollectionViewProvider
-        .provideTextDocumentContent(uri)
-        .then(() => {
-          assert(testQueryStore.operations[operationId].hasMoreDocumentsToShow);
+    // Reset and test inverse.
+    testQueryStore.operations[operationId].currentLimit = 2;
+    testQueryStore.operations[operationId].hasMoreDocumentsToShow = true;
 
-          done();
-        })
-        .catch(done);
-    });
+    await testCollectionViewProvider.provideTextDocumentContent(uri);
+    assert(testQueryStore.operations[operationId].hasMoreDocumentsToShow);
   });
 
-  test('provideTextDocumentContent shows a status bar item while it is running then hide it', (done) => {
+  test('provideTextDocumentContent shows a status bar item while it is running then hide it', async () => {
     const mockActiveDataService = { find: {} } as DataService;
     const mockConnectionController = new ConnectionController(
       new StatusView(mockExtensionContext),
@@ -254,12 +240,8 @@ suite('Collection Documents Provider Test Suite', () => {
       return callback(null, [{ field: 'aaaaaaaaaaaaaaaaa' }]);
     };
 
-    testCollectionViewProvider
-      .provideTextDocumentContent(uri)
-      .then(() => {
-        assert(mockHideMessage.called);
-      })
-      .then(done, done);
+    await testCollectionViewProvider.provideTextDocumentContent(uri);
+    assert(mockHideMessage.called);
   });
 
   test('provideTextDocumentContent sets different code lenses for different namespaces from the same connection', async () => {

src/test/suite/explorer/databaseTreeItem.test.ts

@@ -40,7 +40,7 @@ suite('DatabaseTreeItem Test Suite', () => {
     );
   });
 
-  test('when not expanded it does not show collections', (done) => {
+  test('when not expanded it does not show collections', async () => {
     const testDatabaseTreeItem = new DatabaseTreeItem(
       mockDatabaseNames[1],
       new DataServiceStub(),
@@ -49,15 +49,12 @@ suite('DatabaseTreeItem Test Suite', () => {
       {}
     );
 
-    testDatabaseTreeItem
-      .getChildren()
-      .then((collections) => {
-        assert(
-          collections.length === 0,
-          `Expected no collections to be returned, recieved ${collections.length}`
-        );
-      })
-      .then(done, done);
+    const collections = await testDatabaseTreeItem.getChildren();
+    assert.strictEqual(
+      collections.length,
+      0,
+      `Expected no collections to be returned, recieved ${collections.length}`
+    );
   });
 
   test('when expanded shows the collections of a database in tree', async () => {

src/test/suite/explorer/schemaTreeItem.test.ts

@@ -119,7 +119,7 @@ suite('SchemaTreeItem Test Suite', function () {
     );
   });
 
-  test('it should show a show more item when there are more fields to show', (done) => {
+  test('it should show a show more item when there are more fields to show', async () => {
     const amountOfFieldsExpected = FIELDS_TO_SHOW;
     const mockDocWithTwentyFields = {};
     for (let i = 0; i < 20; i++) {
@@ -140,26 +140,23 @@ suite('SchemaTreeItem Test Suite', function () {
       {}
     );
 
-    testSchemaTreeItem
-      .getChildren()
-      .then((schemaFields) => {
-        assert(FIELDS_TO_SHOW === 15, 'Expeted FIELDS_TO_SHOW to be 15');
-
-        assert(
-          schemaFields.length === amountOfFieldsExpected + 1,
-          `Expected ${
-            amountOfFieldsExpected + 1
-          } documents to be returned, found ${schemaFields.length}`
-        );
-        assert(
-          schemaFields[amountOfFieldsExpected].label === 'Show more fields...',
-          `Expected a tree item child with the label "Show more fields..." found ${schemaFields[amountOfFieldsExpected].label}`
-        );
-      })
-      .then(done, done);
+    const schemaFields = await testSchemaTreeItem.getChildren();
+    assert.strictEqual(FIELDS_TO_SHOW, 15, 'Expeted FIELDS_TO_SHOW to be 15');
+
+    assert.strictEqual(
+      schemaFields.length,
+      amountOfFieldsExpected + 1,
+      `Expected ${amountOfFieldsExpected + 1} documents to be returned, found ${
+        schemaFields.length
+      }`
+    );
+    assert(
+      schemaFields[amountOfFieldsExpected].label === 'Show more fields...',
+      `Expected a tree item child with the label "Show more fields..." found ${schemaFields[amountOfFieldsExpected].label}`
+    );
   });
 
-  test('it should show more fields after the show more click handler is called', (done) => {
+  test('it should show more fields after the show more click handler is called', async () => {
     const mockDocWithThirtyFields = {};
     for (let i = 0; i < 30; i++) {
       mockDocWithThirtyFields[`${i}`] = 'some value';
@@ -181,20 +178,16 @@ suite('SchemaTreeItem Test Suite', function () {
 
     testSchemaTreeItem.onShowMoreClicked();
 
-    testSchemaTreeItem
-      .getChildren()
-      .then((schemaFields) => {
-        const amountOfFieldsExpected = 30;
-
-        assert(
-          schemaFields.length === amountOfFieldsExpected,
-          `Expected ${amountOfFieldsExpected} documents to be returned, found ${schemaFields.length}`
-        );
-      })
-      .then(done, done);
+    const schemaFields = await testSchemaTreeItem.getChildren();
+    const amountOfFieldsExpected = 30;
+
+    assert(
+      schemaFields.length === amountOfFieldsExpected,
+      `Expected ${amountOfFieldsExpected} documents to be returned, found ${schemaFields.length}`
+    );
   });
 
-  test('When schema parsing fails it displays an error message', (done) => {
+  test('When schema parsing fails it displays an error message', async () => {
     const testSchemaTreeItem = new SchemaTreeItem(
       'favoritePiesIWantToEatRightNow',
       TEST_DB_NAME,
@@ -210,23 +203,19 @@ suite('SchemaTreeItem Test Suite', function () {
       {}
     );
 
-    testSchemaTreeItem
-      .getChildren()
-      .then(
-        () => {
-          assert(false, 'Didnt expect to succeed.');
-        },
-        (error) => {
-          const expectedMessage =
-            'Unable to parse schema: Unknown input type for `docs`. Must be an array, stream or MongoDB Cursor.';
-
-          assert(
-            error.message === expectedMessage,
-            `Expected error message to be "${expectedMessage}" found "${error.message}"`
-          );
-        }
-      )
-      .then(done, done);
+    try {
+      await testSchemaTreeItem.getChildren();
+      assert(false, 'Didnt expect to succeed.');
+    } catch (error: any) {
+      const expectedMessage =
+        'Unable to parse schema: Unknown input type for `docs`. Must be an array, stream or MongoDB Cursor.';
+
+      assert.strictEqual(
+        error.message,
+        expectedMessage,
+        `Expected error message to be "${expectedMessage}" found "${error.message}"`
+      );
+    }
   });
 
   suite('Live Database Tests', () => {