test(cli): provide full cli tests for both v2 and v3

.github/workflows/test.yml

@@ -75,16 +75,3 @@ jobs:
       - name: Test
         id: test
         run: yarn test
-
-      # Required for import lint rules to work - packages pointing to ex
-      # `lib/index.js`, where `src/index.ts` gets compiled to `lib/index.js`
-      - name: Build modules
-        id: buildResolver
-        run: yarn build
-        env:
-          NODE_OPTIONS: --max_old_space_size=8192
-
-      - name: Test CLI
-        working-directory: ${{ env.GITHUB_WORKSPACE }}
-        run: |
-          node scripts/testCli.js

package.json

@@ -138,7 +138,6 @@
     "start-server-and-test": "^1.14.0",
     "tmp": "^0.2.1",
     "typescript": "^4.8.3",
-    "undici": "^5.8.2",
     "yargs": "^17.3.0"
   },
   "optionalDependencies": {

packages/@sanity/cli/jest.config.cjs

@@ -0,0 +1,13 @@
+'use strict'
+
+const {createJestConfig} = require('../../../test/config.cjs')
+
+module.exports = createJestConfig({
+  displayName: require('./package.json').name,
+  testEnvironment: 'node',
+  rootDir: __dirname,
+  globalSetup: '<rootDir>/test/shared/globalSetup.ts',
+  globalTeardown: '<rootDir>/test/shared/globalTeardown.ts',
+  slowTestThreshold: 60000,
+  testTimeout: 30000,
+})

packages/@sanity/cli/package.json

@@ -43,7 +43,8 @@
     "postbuild": "run-s check:package",
     "prebuild": "run-s clean",
     "watch": "pkg-utils watch --tsconfig tsconfig.lib.json",
-    "ts": "node -r esbuild-register"
+    "ts": "node -r esbuild-register",
+    "test": "jest"
   },
   "dependencies": {
     "@babel/traverse": "^7.19.0",
@@ -60,6 +61,7 @@
     "@sanity/types": "3.0.0-dev-preview.20",
     "@sanity/util": "3.0.0-dev-preview.20",
     "@types/configstore": "^5.0.1",
+    "@types/cpx": "^1.5.2",
     "@types/babel__traverse": "^7.18.1",
     "@types/decompress": "^4.2.4",
     "@types/eventsource": "^1.1.8",
@@ -73,6 +75,7 @@
     "chalk": "^4.1.2",
     "clean-stack": "^3.0.0",
     "configstore": "^5.0.1",
+    "cpx": "^1.5.0",
     "debug": "^3.2.7",
     "decompress": "^4.2.0",
     "deep-sort-object": "^1.0.1",

packages/@sanity/cli/test/.eslintrc

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "max-nested-callbacks": "off"
+  }
+}

packages/@sanity/cli/test/__fixtures__/v2/components/MyLogo.jsx

@@ -0,0 +1,7 @@
+import React from 'react'
+import styles from './MyLogo.module.css'
+
+// Test that we can import CSS modules and that they get bundled
+export function MyLogo() {
+  return <div className={styles.logo}>Hello</div>
+}

packages/@sanity/cli/test/__fixtures__/v2/components/MyLogo.module.css

@@ -0,0 +1,3 @@
+.logo {
+  background: green;
+}

packages/@sanity/cli/test/__fixtures__/v2/document.json

@@ -0,0 +1,5 @@
+{
+  "_id": "drafts.magnus-carlsen",
+  "_type": "person",
+  "name": "Magnus Carlsen"
+}

packages/@sanity/cli/test/__fixtures__/v2/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "v2-studio",
+  "private": true,
+  "version": "0.0.1",
+  "description": "A Sanity v2 studio for CI testing.",
+  "author": "Sanity.io <hello@sanity.io>",
+  "license": "MIT",
+  "scripts": {
+    "build": "sanity build",
+    "start": "sanity start"
+  },
+  "keywords": [
+    "fixture"
+  ],
+  "dependencies": {
+    "@sanity/base": "^2.33.3",
+    "@sanity/cli": "^2.33.3",
+    "@sanity/core": "^2.33.3",
+    "@sanity/default-layout": "^2.33.3",
+    "@sanity/default-login": "^2.33.3",
+    "@sanity/desk-tool": "^2.33.3",
+    "react": "17.0.2",
+    "react-dom": "17.0.2",
+    "styled-components": "^5.2.0"
+  }
+}

test/v2-studio/sanity.json → packages/@sanity/cli/test/__fixtures__/v2/sanity.json

@@ -4,19 +4,26 @@
     "name": "v2 studio"
   },
   "api": {
-    "projectId": "ppsg7ml5",
-    "dataset": "test"
+    "projectId": "aeysrmym",
+    "dataset": "production"
   },
   "plugins": [
     "@sanity/base",
     "@sanity/default-layout",
     "@sanity/default-login",
     "@sanity/desk-tool"
   ],
+  "server": {
+    "port": 3334
+  },
   "parts": [
     {
       "name": "part:@sanity/base/schema",
       "path": "schema"
+    },
+    {
+      "implements": "part:@sanity/base/brand-logo",
+      "path": "./components/MyLogo.jsx"
     }
   ]
 }

packages/@sanity/cli/test/__fixtures__/v2/schema.js

@@ -0,0 +1,38 @@
+/* eslint-disable import/no-unresolved */
+import schemaTypes from 'all:part:@sanity/base/schema-type'
+import createSchema from 'part:@sanity/base/schema-creator'
+
+export default createSchema({
+  name: 'v2-schema',
+  types: schemaTypes.concat([
+    {
+      name: 'person',
+      title: 'Person',
+      type: 'document',
+      fields: [
+        {
+          name: 'name',
+          title: 'Name',
+          type: 'string',
+        },
+        {
+          name: 'slug',
+          title: 'Slug',
+          type: 'slug',
+          options: {
+            source: 'name',
+            maxLength: 100,
+          },
+        },
+        {
+          name: 'image',
+          title: 'Image',
+          type: 'image',
+          options: {
+            hotspot: true,
+          },
+        },
+      ],
+    },
+  ]),
+})

packages/@sanity/cli/test/__fixtures__/v2/script.js

@@ -0,0 +1,11 @@
+/* eslint-disable import/no-unresolved, no-console */
+// Tests that `sanity exec` in v2 can import parts, and use a preconfigured client
+import client from 'part:@sanity/base/client'
+
+client
+  .withConfig({apiVersion: '2022-09-09'})
+  .users.getById('me')
+  .then(
+    (user) => console.log(JSON.stringify(user, null, 2)),
+    (err) => console.error(err)
+  )

packages/@sanity/cli/test/__fixtures__/v3/.eslintrc

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "import/no-extraneous-dependencies": "off"
+  }
+}

packages/@sanity/cli/test/__fixtures__/v3/components/MyLogo.jsx

@@ -0,0 +1,7 @@
+import React from 'react'
+import styles from './MyLogo.module.css'
+
+// Test that we can import CSS modules and that they get bundled
+export function MyLogo() {
+  return <div className={styles.logo}>Hello</div>
+}

packages/@sanity/cli/test/__fixtures__/v3/components/MyLogo.module.css

@@ -0,0 +1,3 @@
+.logo {
+  background: green;
+}

packages/@sanity/cli/test/__fixtures__/v3/document.json

@@ -0,0 +1,5 @@
+{
+  "_id": "drafts.magnus-carlsen",
+  "_type": "person",
+  "name": "Magnus Carlsen"
+}

packages/@sanity/cli/test/__fixtures__/v3/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "v3-studio",
+  "private": true,
+  "version": "0.0.1",
+  "description": "A Sanity v3 studio for CI testing.",
+  "author": "Sanity.io <hello@sanity.io>",
+  "license": "MIT",
+  "scripts": {
+    "build": "sanity build",
+    "start": "sanity start"
+  },
+  "keywords": [
+    "fixture"
+  ],
+  "dependencies": {
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "sanity": "3.0.0-dev-preview.20",
+    "styled-components": "^5.2.0"
+  }
+}

packages/@sanity/cli/test/__fixtures__/v3/sanity.cli.ts

@@ -0,0 +1,15 @@
+import {createCliConfig} from 'sanity/cli'
+
+export default createCliConfig({
+  api: {
+    projectId: 'aeysrmym',
+    dataset: 'production',
+  },
+
+  graphql: [
+    {
+      playground: false,
+      workspace: 'default', // @todo remove
+    },
+  ],
+})

packages/@sanity/cli/test/__fixtures__/v3/sanity.config.ts

@@ -0,0 +1,11 @@
+import {createConfig} from 'sanity'
+import {MyLogo} from './components/MyLogo'
+import {schema} from './schema'
+
+export default createConfig({
+  name: 'default', // @todo remove
+  projectId: 'aeysrmym',
+  dataset: 'production',
+  logo: MyLogo,
+  schema,
+})

packages/@sanity/cli/test/__fixtures__/v3/schema.ts

@@ -0,0 +1,34 @@
+export const schema = {
+  name: 'default',
+  types: [
+    {
+      name: 'person',
+      title: 'Person',
+      type: 'document',
+      fields: [
+        {
+          name: 'name',
+          title: 'Name',
+          type: 'string',
+        },
+        {
+          name: 'slug',
+          title: 'Slug',
+          type: 'slug',
+          options: {
+            source: 'name',
+            maxLength: 100,
+          },
+        },
+        {
+          name: 'image',
+          title: 'Image',
+          type: 'image',
+          options: {
+            hotspot: true,
+          },
+        },
+      ],
+    },
+  ],
+}

packages/@sanity/cli/test/__fixtures__/v3/script.ts

@@ -0,0 +1,11 @@
+/* eslint-disable no-console */
+// Tests that `sanity exec` in v3 can import the CLI client
+import {getCliClient} from 'sanity/cli'
+
+getCliClient()
+  .withConfig({apiVersion: '2022-09-09'})
+  .users.getById('me')
+  .then(
+    (user) => console.log(JSON.stringify(user, null, 2)),
+    (err) => console.error(err)
+  )