Add integration test

Author: gagik

packages/shell-api/src/helpers.ts

@@ -671,7 +671,7 @@ export async function getPrintableShardStatus(
   let shardedDataDistribution: ShardedDataDistribution | undefined;
 
   try {
-    // Available since 6.0.3
+    // Available since >= 6.0.3
     const adminDb = db.getSiblingDB('admin');
     shardedDataDistribution = (await (
       await adminDb.aggregate([{ $shardedDataDistribution: {} }])
@@ -686,7 +686,7 @@ export async function getPrintableShardStatus(
   return result;
 }
 
-type ShardingStatusResult = {
+export type ShardingStatusResult = {
   shardingVersion: {
     _id: number;
     clusterId: ObjectId;
@@ -697,6 +697,7 @@ type ShardingStatusResult = {
     _id: string;
     host: string;
     state: number;
+    tags: string[];
     topologyTime: Timestamp;
     replSetConfigVersion: Long;
   }[];

packages/shell-api/src/shard.spec.ts

@@ -32,6 +32,7 @@ import {
 import Database from './database';
 import { inspect } from 'util';
 import { dummyOptions } from './helpers.spec';
+import type { ShardedDataDistribution } from './helpers';
 
 describe('Shard', function () {
   skipIfApiStrict();
@@ -2121,7 +2122,7 @@ describe('Shard', function () {
         expect(
           (await sh.status()).value.databases.find(
             (d: Document) => d.database._id === 'test'
-          ).collections[ns].shardKey
+          )?.collections[ns].shardKey
         ).to.deep.equal({ key: 1 });
 
         const db = instanceState.currentDb.getSiblingDB(dbName);
@@ -2166,13 +2167,13 @@ describe('Shard', function () {
     describe('tags', function () {
       it('creates a zone', async function () {
         expect((await sh.addShardTag(`${shardId}-1`, 'zone1')).ok).to.equal(1);
-        expect((await sh.status()).value.shards[1].tags).to.deep.equal([
+        expect((await sh.status()).value.shards[1]?.tags).to.deep.equal([
           'zone1',
         ]);
         expect((await sh.addShardToZone(`${shardId}-0`, 'zone0')).ok).to.equal(
           1
         );
-        expect((await sh.status()).value.shards[0].tags).to.deep.equal([
+        expect((await sh.status()).value.shards[0]?.tags).to.deep.equal([
           'zone0',
         ]);
       });
@@ -2241,7 +2242,7 @@ describe('Shard', function () {
 
         const tags = (await sh.status()).value.databases.find(
           (d: Document) => d.database._id === 'test'
-        ).collections[ns].tags;
+        )?.collections[ns].tags;
         expect(tags.length).to.equal(19);
       });
       it('cuts a tag list when there are more than 20 tags', async function () {
@@ -2251,7 +2252,7 @@ describe('Shard', function () {
 
         const tags = (await sh.status()).value.databases.find(
           (d: Document) => d.database._id === 'test'
-        ).collections[ns].tags;
+        )?.collections[ns].tags;
         expect(tags.length).to.equal(21);
         expect(
           tags.indexOf(
@@ -2885,6 +2886,87 @@ describe('Shard', function () {
         });
       });
     });
+
+    describe('collection.status()', function () {
+      let db: Database;
+
+      const dbName = 'shard-stats-test';
+      const ns = `${dbName}.test`;
+
+      beforeEach(async function () {
+        db = sh._database.getSiblingDB(dbName);
+        await db.getCollection('test').insertOne({ key: 1 });
+        await db.getCollection('test').createIndex({ key: 1 });
+      });
+      afterEach(async function () {
+        await db.dropDatabase();
+      });
+      describe('unsharded collections', function () {
+        describe('with >= 6.0.3', function () {
+          skipIfServerVersion(mongos, '< 6.0.3');
+
+          it('returns shardedDataDistribution as an empty array', async function () {
+            const status = await sh.status();
+            expect(status.value.shardedDataDistribution).deep.equals([]);
+          });
+        });
+
+        describe('with < 6.0.3', function () {
+          skipIfServerVersion(mongos, '>= 6.0.3');
+
+          it('returns shardedDataDistribution as undefined', async function () {
+            const status = await sh.status();
+            expect(status.value.shardedDataDistribution).equals(undefined);
+          });
+        });
+      });
+
+      describe('sharded collections', function () {
+        beforeEach(async function () {
+          expect((await sh.enableSharding(dbName)).ok).to.equal(1);
+          expect(
+            (await sh.shardCollection(ns, { key: 1 })).collectionsharded
+          ).to.equal(ns);
+        });
+
+        describe('with >= 6.0.3', function () {
+          skipIfServerVersion(mongos, '< 6.0.3');
+
+          it('returns correct shardedDataDistribution', async function () {
+            const expectedShardedDataDistribution: ShardedDataDistribution = [
+              {
+                ns: 'shard-stats-test.test',
+                shards: [
+                  {
+                    shardName: 'rs-shard0-0',
+                    numOrphanedDocs: 0,
+                    numOwnedDocuments: 1,
+                    ownedSizeBytes: 31,
+                    orphanedSizeBytes: 0,
+                  },
+                ],
+              },
+            ];
+
+            const status = await sh.status();
+
+            expect(status.value.shardedDataDistribution).deep.equals(
+              expectedShardedDataDistribution
+            );
+          });
+        });
+
+        describe('with < 6.0.3', function () {
+          skipIfServerVersion(mongos, '>= 6.0.3');
+
+          it('returns shardedDataDistribution as undefined', async function () {
+            const status = await sh.status();
+            expect(status.value.shardedDataDistribution).equals(undefined);
+          });
+        });
+      });
+    });
+
     describe('collection.isCapped', function () {
       it('returns true for config.changelog', async function () {
         const ret = await sh._database
@@ -2929,15 +3011,15 @@ describe('Shard', function () {
           (item: Document) => item.database._id === 'db'
         );
         // Cannot get strict guarantees about the value of this field since SERVER-63983
-        expect(databasesDbItem.database.partitioned).to.be.oneOf([
+        expect(databasesDbItem?.database.partitioned).to.be.oneOf([
           false,
           undefined,
         ]);
         const databasesDbShItem = result.value.databases.find(
           (item: Document) => item.database._id === 'dbSh'
         );
         // Cannot get strict guarantees about the value of this field since SERVER-60926 and SERVER-63983
-        expect(databasesDbShItem.database.partitioned).to.be.oneOf([
+        expect(databasesDbShItem?.database.partitioned).to.be.oneOf([
           true,
           false,
           undefined,
@@ -3051,15 +3133,15 @@ describe('Shard', function () {
       }
       const chunks = (await sh.status()).value.databases.find(
         (d: Document) => d.database._id === 'test'
-      ).collections[ns].chunks;
+      )?.collections[ns].chunks;
       expect(chunks.length).to.equal(20);
     });
 
     it('cuts a chunk list when there are more than 20 chunks', async function () {
       await sh.splitAt(ns, { key: 20 });
       const chunks = (await sh.status()).value.databases.find(
         (d: Document) => d.database._id === 'test'
-      ).collections[ns].chunks;
+      )?.collections[ns].chunks;
       expect(chunks.length).to.equal(21);
       expect(
         chunks.indexOf(

packages/shell-api/src/shard.ts

@@ -12,10 +12,12 @@ import type {
   Document,
   CheckMetadataConsistencyOptions,
 } from '@mongosh/service-provider-core';
+import type { ShardingStatusResult } from './helpers';
 import {
   assertArgsDefinedType,
   getConfigDB,
   getPrintableShardStatus,
+  ShardedDataDistribution,
 } from './helpers';
 import { ServerVersions, asPrintable } from './enums';
 import type { UpdateResult } from './result';
@@ -205,7 +207,7 @@ export default class Shard extends ShellApiWithMongoClass {
   async status(
     verbose = false,
     configDB?: Database
-  ): Promise<CommandResult<Document>> {
+  ): Promise<CommandResult<ShardingStatusResult>> {
     const result = await getPrintableShardStatus(
       configDB ?? (await getConfigDB(this._database)),
       verbose