[Dev] enable opensearch snapshot for Darwin

Enable the downloading of Darwin for running the command
`yarn opensearch snapshot`.

Darwin is not officially supported but snapshots are being
built here:
https://build.ci.opensearch.org/job/distribution-build-opensearch/

Issue resolved:
opensearch-project#2944

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

CHANGELOG.md

@@ -64,6 +64,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - [Multiple DataSource] Add support for SigV4 authentication ([#3058](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/3058))
 - Make build scripts find and use the latest version of Node.js that satisfies `engines.node` ([#3467](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/3467))
 - [Multiple DataSource] Refactor test connection to support SigV4 auth type ([#3456](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/3456))
+- [Darwin] Add support for Darwin for running OpenSearch snapshots with `yarn opensearch snapshot` ([#3537](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3537))
 
 ### 🐛 Bug Fixes
 

DEVELOPER_GUIDE.md

@@ -110,7 +110,7 @@ $ yarn osd clean
 
 OpenSearch Dashboards requires a running version of OpenSearch to connect to. In a separate terminal you can run the latest snapshot built using:
 
-_(Linux and Windows only - for MacOS, you'll need to [run OpenSearch from a tarball](#alternative---run-opensearch-from-tarball) instead)_
+_(Linux, Windows, Darwin only - for others, you'll need to [run OpenSearch from a tarball](#alternative---run-opensearch-from-tarball) instead)_
 ```bash
 $ yarn opensearch snapshot
 ```

packages/osd-opensearch/src/artifact.js

@@ -38,6 +38,7 @@ const { createHash } = require('crypto');
 const path = require('path');
 
 const asyncPipeline = promisify(pipeline);
+const SUPPORTED_PLATFORMS = ['linux', 'windows', 'darwin'];
 const DAILY_SNAPSHOTS_BASE_URL = 'https://artifacts.opensearch.org/snapshots/core/opensearch';
 // TODO: [RENAMEME] currently do not have an existing replacement
 // issue: https://github.com/opensearch-project/OpenSearch-Dashboards/issues/475
@@ -188,8 +189,8 @@ async function getArtifactSpecForSnapshotFromUrl(urlVersion, log) {
   const arch = process.arch === 'arm64' ? 'arm64' : 'x64';
   const extension = process.platform === 'win32' ? 'zip' : 'tar.gz';
 
-  if (platform !== 'linux' && platform !== 'windows') {
-    throw createCliError(`Snapshots are only available for Linux and Windows`);
+  if (!SUPPORTED_PLATFORMS.includes(platform)) {
+    throw createCliError(`Snapshots are only available for Linux, Windows, and Darwin`);
   }
 
   const latestUrl = `${DAILY_SNAPSHOTS_BASE_URL}/${desiredVersion}-SNAPSHOT`;

packages/osd-opensearch/src/artifact.test.js

@@ -163,17 +163,17 @@ describe('Artifact', () => {
         });
       });
 
-      it('should throw when on a non-Linux or non-Windows platform', async () => {
+      it('should throw when on a non-Linux, non-Windows, non-Darwin platform', async () => {
         Object.defineProperties(process, {
           platform: {
-            value: 'darwin',
+            value: 'android',
           },
           arch: {
             value: ORIGINAL_ARCHITECTURE,
           },
         });
         await expect(Artifact.getSnapshot('default', 'INVALID_PLATFORM', log)).rejects.toThrow(
-          'Snapshots are only available for Linux'
+          'Snapshots are only available for Linux, Windows, and Darwin'
         );
       });
 
@@ -189,6 +189,42 @@ describe('Artifact', () => {
         mockFetch(MOCKS.multipleArch[0]);
         artifactTest();
       });
+
+      it('should not throw when on a Linux platform', async () => {
+        Object.defineProperties(process, {
+          platform: {
+            value: 'linux',
+          },
+          arch: {
+            value: 'x64',
+          },
+        });
+        artifactTest();
+      });
+
+      it('should not throw when on a Windows platform', async () => {
+        Object.defineProperties(process, {
+          platform: {
+            value: 'win32',
+          },
+          arch: {
+            value: 'x64',
+          },
+        });
+        artifactTest();
+      });
+
+      it('should not throw when on a Darwin platform', async () => {
+        Object.defineProperties(process, {
+          platform: {
+            value: 'darwin',
+          },
+          arch: {
+            value: 'x64',
+          },
+        });
+        artifactTest();
+      });
     });
 
     describe('with custom snapshot manifest URL', () => {