Create test file for each command, move dryrun tests there (#363)

Author: pvdz

package.json

@@ -66,6 +66,7 @@
     "test:unit:coverage": "vitest run --coverage",
     "test-ci": "run-s test:*",
     "testu": "cross-env SOCKET_CLI_NO_API_TOKEN=1 run-s test:prepare; npm run test:unit:update --",
+    "testuf": "SOCKET_CLI_NO_API_TOKEN=1 npm run test:unit:update --",
     "update": "run-p --aggregate-output update:**",
     "update:deps": "npx --yes npm-check-updates"
   },

src/commands/analytics/cmd-analytics.test.ts

@@ -0,0 +1,73 @@
+import path from 'node:path'
+
+import { describe, expect } from 'vitest'
+
+import constants from '../../../dist/constants.js'
+import { cmdit, invokeNpm } from '../../../test/utils'
+
+const { CLI } = constants
+
+describe('socket analytics', async () => {
+  // Lazily access constants.rootBinPath.
+  const entryPath = path.join(constants.rootBinPath, `${CLI}.js`)
+
+  cmdit(['analytics', '--help'], 'should support --help', async cmd => {
+    const { code, stderr, stdout } = await invokeNpm(entryPath, cmd)
+    expect(stdout).toMatchInlineSnapshot(
+      `
+      "Look up analytics data
+
+        Usage
+          $ socket analytics --scope=<scope> --time=<time filter>
+
+        Default parameters are set to show the organization-level analytics over the
+        last 7 days.
+
+        Options
+          --dryRun          Do input validation for a command and exit 0 when input is ok
+          --file            Path to a local file to save the output. Only valid with --json/--markdown. Defaults to stdout.
+          --help            Print this help.
+          --json            Output result as json
+          --markdown        Output result as markdown
+          --repo            Name of the repository. Only valid when scope=repo
+          --scope           Scope of the analytics data - either 'org' or 'repo', default: org
+          --time            Time filter - either 7, 30 or 90, default: 7
+
+        Examples
+          $ socket analytics --scope=org --time=7
+          $ socket analytics --scope=org --time=30
+          $ socket analytics --scope=repo --repo=test-repo --time=30"
+    `
+    )
+    expect(`\n   ${stderr}`).toMatchInlineSnapshot(`
+      "
+         _____         _       _        /---------------
+        |   __|___ ___| |_ ___| |_      | Socket.dev CLI ver <redacted>
+        |__   | . |  _| '_| -_|  _|     | Node: <redacted>, API token set: <redacted>
+        |_____|___|___|_,_|___|_|.dev   | Command: \`socket analytics\`, cwd: <redacted>"
+    `)
+
+    expect(code, 'help should exit with code 2').toBe(2)
+    expect(stderr, 'header should include command (without params)').toContain(
+      '`socket analytics`'
+    )
+  })
+
+  cmdit(
+    ['analytics', '--dry-run'],
+    'should require args with just dry-run',
+    async cmd => {
+      const { code, stderr, stdout } = await invokeNpm(entryPath, cmd)
+      expect(stdout).toMatchInlineSnapshot(`"[DryRun]: Bailing now"`)
+      expect(`\n   ${stderr}`).toMatchInlineSnapshot(`
+        "
+           _____         _       _        /---------------
+          |   __|___ ___| |_ ___| |_      | Socket.dev CLI ver <redacted>
+          |__   | . |  _| '_| -_|  _|     | Node: <redacted>, API token set: <redacted>
+          |_____|___|___|_,_|___|_|.dev   | Command: \`socket analytics\`, cwd: <redacted>"
+      `)
+
+      expect(code, 'dry-run should exit with code 0 if input ok').toBe(0)
+    }
+  )
+})

src/commands/audit-log/cmd-audit-log.test.ts

@@ -0,0 +1,92 @@
+import path from 'node:path'
+
+import { describe, expect } from 'vitest'
+
+import constants from '../../../dist/constants.js'
+import { cmdit, invokeNpm } from '../../../test/utils'
+
+const { CLI } = constants
+
+describe('socket audit-log', async () => {
+  // Lazily access constants.rootBinPath.
+  const entryPath = path.join(constants.rootBinPath, `${CLI}.js`)
+
+  cmdit(['audit-log', '--help'], 'should support --help', async cmd => {
+    const { code, stderr, stdout } = await invokeNpm(entryPath, cmd)
+    expect(stdout).toMatchInlineSnapshot(
+      `
+      "Look up the audit log for an organization
+
+        Usage
+          $ socket audit-log <org slug>
+
+        This feature requires an Enterprise Plan. To learn more about getting access
+        to this feature and many more, please visit https://socket.dev/pricing
+
+        Options
+          --dryRun          Do input validation for a command and exit 0 when input is ok
+          --help            Print this help.
+          --json            Output result as json
+          --markdown        Output result as markdown
+          --page            Page number - default is 1
+          --perPage         Results per page - default is 30
+          --type            Type of log event
+
+        Examples
+          $ socket audit-log FakeOrg"
+    `
+    )
+    expect(`\n   ${stderr}`).toMatchInlineSnapshot(`
+      "
+         _____         _       _        /---------------
+        |   __|___ ___| |_ ___| |_      | Socket.dev CLI ver <redacted>
+        |__   | . |  _| '_| -_|  _|     | Node: <redacted>, API token set: <redacted>
+        |_____|___|___|_,_|___|_|.dev   | Command: \`socket audit-log\`, cwd: <redacted>"
+    `)
+
+    expect(code, 'help should exit with code 2').toBe(2)
+    expect(stderr, 'header should include command (without params)').toContain(
+      '`socket audit-log`'
+    )
+  })
+
+  cmdit(
+    ['audit-log', '--dry-run'],
+    'should require args with just dry-run',
+    async cmd => {
+      const { code, stderr, stdout } = await invokeNpm(entryPath, cmd)
+      expect(stdout).toMatchInlineSnapshot(`""`)
+      expect(`\n   ${stderr}`).toMatchInlineSnapshot(`
+        "
+           _____         _       _        /---------------
+          |   __|___ ___| |_ ___| |_      | Socket.dev CLI ver <redacted>
+          |__   | . |  _| '_| -_|  _|     | Node: <redacted>, API token set: <redacted>
+          |_____|___|___|_,_|___|_|.dev   | Command: \`socket audit-log\`, cwd: <redacted>
+
+        \\x1b[31m\\xd7\\x1b[39m \\x1b[41m\\x1b[37mInput error\\x1b[39m\\x1b[49m: Please provide the required fields:
+
+        - Org name as the first argument \\x1b[31m(missing!)\\x1b[39m"
+      `)
+
+      expect(code, 'dry-run should exit with code 2 if missing input').toBe(2)
+    }
+  )
+
+  cmdit(
+    ['audit-log', 'fakeorg', '--dry-run'],
+    'should require args with just dry-run',
+    async cmd => {
+      const { code, stderr, stdout } = await invokeNpm(entryPath, cmd)
+      expect(stdout).toMatchInlineSnapshot(`"[DryRun]: Bailing now"`)
+      expect(`\n   ${stderr}`).toMatchInlineSnapshot(`
+        "
+           _____         _       _        /---------------
+          |   __|___ ___| |_ ___| |_      | Socket.dev CLI ver <redacted>
+          |__   | . |  _| '_| -_|  _|     | Node: <redacted>, API token set: <redacted>
+          |_____|___|___|_,_|___|_|.dev   | Command: \`socket audit-log\`, cwd: <redacted>"
+      `)
+
+      expect(code, 'dry-run should exit with code 0 if input ok').toBe(0)
+    }
+  )
+})

src/commands/cdxgen/cmd-cdxgen.test.ts

@@ -0,0 +1,109 @@
+import path from 'node:path'
+
+import { describe, expect } from 'vitest'
+
+import constants from '../../../dist/constants.js'
+import { cmdit, invokeNpm } from '../../../test/utils'
+
+const { CLI } = constants
+
+describe('socket cdxgen', async () => {
+  // Lazily access constants.rootBinPath.
+  const entryPath = path.join(constants.rootBinPath, `${CLI}.js`)
+
+  cmdit(['cdxgen', '--help'], 'should support --help', async cmd => {
+    const { code, stderr, stdout } = await invokeNpm(entryPath, cmd)
+    expect(stdout).toMatchInlineSnapshot(
+      `
+      "cdxgen [command]
+
+      Commands:
+        cdxgen completion  Generate bash/zsh completion
+
+      Options:
+        -o, --output                 Output file. Default bom.json  [default: "bom.json"]
+        -t, --type                   Project type. Please refer to https://cyclonedx.github.io/cdxgen/#/PROJECT_TYPES for supported languages/platforms.  [array]
+            --exclude-type           Project types to exclude. Please refer to https://cyclonedx.github.io/cdxgen/#/PROJECT_TYPES for supported languages/platforms.
+        -r, --recurse                Recurse mode suitable for mono-repos. Defaults to true. Pass --no-recurse to disable.  [boolean] [default: true]
+        -p, --print                  Print the SBOM as a table with tree.  [boolean]
+        -c, --resolve-class          Resolve class names for packages. jars only for now.  [boolean]
+            --deep                   Perform deep searches for components. Useful while scanning C/C++ apps, live OS and oci images.  [boolean]
+            --server-url             Dependency track url. Eg: https://deptrack.cyclonedx.io
+            --skip-dt-tls-check      Skip TLS certificate check when calling Dependency-Track.  [boolean] [default: false]
+            --api-key                Dependency track api key
+            --project-group          Dependency track project group
+            --project-name           Dependency track project name. Default use the directory name
+            --project-version        Dependency track project version  [string] [default: ""]
+            --project-id             Dependency track project id. Either provide the id or the project name and version together  [string]
+            --parent-project-id      Dependency track parent project id  [string]
+            --required-only          Include only the packages with required scope on the SBOM. Would set compositions.aggregate to incomplete unless --no-auto-compositions is passed.  [boolean]
+            --fail-on-error          Fail if any dependency extractor fails.  [boolean]
+            --no-babel               Do not use babel to perform usage analysis for JavaScript/TypeScript projects.  [boolean]
+            --generate-key-and-sign  Generate an RSA public/private key pair and then sign the generated SBOM using JSON Web Signatures.  [boolean]
+            --server                 Run cdxgen as a server  [boolean]
+            --server-host            Listen address  [default: "127.0.0.1"]
+            --server-port            Listen port  [default: "9090"]
+            --install-deps           Install dependencies automatically for some projects. Defaults to true but disabled for containers and oci scans. Use --no-install-deps to disable this feature.  [boolean] [default: true]
+            --validate               Validate the generated SBOM using json schema. Defaults to true. Pass --no-validate to disable.  [boolean] [default: true]
+            --evidence               Generate SBOM with evidence for supported languages.  [boolean] [default: false]
+            --spec-version           CycloneDX Specification version to use. Defaults to 1.6  [number] [default: 1.6]
+            --filter                 Filter components containing this word in purl or component.properties.value. Multiple values allowed.  [array]
+            --only                   Include components only containing this word in purl. Useful to generate BOM with first party components alone. Multiple values allowed.  [array]
+            --author                 The person(s) who created the BOM. Set this value if you're intending the modify the BOM and claim authorship.  [array] [default: "OWASP Foundation"]
+            --profile                BOM profile to use for generation. Default generic.  [choices: "appsec", "research", "operational", "threat-modeling", "license-compliance", "generic", "machine-learning", "ml", "deep-learning", "ml-deep", "ml-tiny"] [default: "generic"]
+            --exclude                Additional glob pattern(s) to ignore  [array]
+            --include-formulation    Generate formulation section with git metadata and build tools. Defaults to false.  [boolean] [default: false]
+            --include-crypto         Include crypto libraries as components.  [boolean] [default: false]
+            --standard               The list of standards which may consist of regulations, industry or organizational-specific standards, maturity models, best practices, or any other requirements which can be evaluated against or attested to.  [array] [choices: "asvs-5.0", "asvs-4.0.3", "bsimm-v13", "masvs-2.0.0", "nist_ssdf-1.1", "pcissc-secure-slc-1.1", "scvs-1.0.0", "ssaf-DRAFT-2023-11"]
+            --min-confidence         Minimum confidence needed for the identity of a component from 0 - 1, where 1 is 100% confidence.  [number] [default: 0]
+            --technique              Analysis technique to use  [array] [choices: "auto", "source-code-analysis", "binary-analysis", "manifest-analysis", "hash-comparison", "instrumentation", "filename"]
+            --auto-compositions      Automatically set compositions when the BOM was filtered. Defaults to true  [boolean] [default: true]
+        -h, --help                   Show help  [boolean]
+        -v, --version                Show version number  [boolean]
+
+      Examples:
+        cdxgen -t java .                       Generate a Java SBOM for the current directory
+        cdxgen -t java -t js .                 Generate a SBOM for Java and JavaScript in the current directory
+        cdxgen -t java --profile ml .          Generate a Java SBOM for machine learning purposes.
+        cdxgen -t python --profile research .  Generate a Python SBOM for appsec research.
+        cdxgen --server                        Run cdxgen as a server
+
+      for documentation, visit https://cyclonedx.github.io/cdxgen"
+    `
+    )
+    expect(`\n   ${stderr}`).toMatchInlineSnapshot(`
+      "
+         _____         _       _        /---------------
+        |   __|___ ___| |_ ___| |_      | Socket.dev CLI ver <redacted>
+        |__   | . |  _| '_| -_|  _|     | Node: <redacted>, API token set: <redacted>
+        |_____|___|___|_,_|___|_|.dev   | Command: \`socket cdxgen\`, cwd: <redacted>"
+    `)
+
+    // expect(code, 'help should exit with code 2').toBe(2)
+    expect(code, 'help should exit with code 2').toBe(0) // cdxgen special case
+    expect(stderr, 'header should include command (without params)').toContain(
+      '`socket cdxgen`'
+    )
+  })
+
+  // cdxgen does not support --dry-run
+  // cmdit(
+  //   ['cdxgen', '--dry-run'],
+  //   'should require args with just dry-run',
+  //   async cmd => {
+  //     const { code, stderr, stdout } = await invokeNpm(entryPath, cmd)
+  //     expect(stdout).toMatchInlineSnapshot(`""`)
+  //     expect(`\n   ${stderr}`).toMatchInlineSnapshot(`
+  //       "
+  //          _____         _       _        /---------------
+  //         |   __|___ ___| |_ ___| |_      | Socket.dev CLI ver <redacted>
+  //         |__   | . |  _| '_| -_|  _|     | Node: <redacted>, API token set: <redacted>
+  //         |_____|___|___|_,_|___|_|.dev   | Command: \`socket cdxgen\`, cwd: <redacted>
+  //
+  //       \\x1b[31m\\xd7\\x1b[39m Unknown argument: --dry-run"
+  //     `)
+  //
+  //     expect(code, 'dry-run should exit with code 0 if input ok').toBe(0)
+  //   }
+  // )
+})

src/commands/dependencies/cmd-dependencies.test.ts

@@ -0,0 +1,66 @@
+import path from 'node:path'
+
+import { describe, expect } from 'vitest'
+
+import constants from '../../../dist/constants.js'
+import { cmdit, invokeNpm } from '../../../test/utils'
+
+const { CLI } = constants
+
+describe('socket dependencies', async () => {
+  // Lazily access constants.rootBinPath.
+  const entryPath = path.join(constants.rootBinPath, `${CLI}.js`)
+
+  cmdit(['dependencies', '--help'], 'should support --help', async cmd => {
+    const { code, stderr, stdout } = await invokeNpm(entryPath, cmd)
+    expect(stdout).toMatchInlineSnapshot(
+      `
+      "Search for any dependency that is being used in your organization
+
+        Usage
+          socket dependencies
+
+        Options
+          --dryRun          Do input validation for a command and exit 0 when input is ok
+          --help            Print this help.
+          --json            Output result as json
+          --limit           Maximum number of dependencies returned
+          --markdown        Output result as markdown
+          --offset          Page number
+
+        Examples
+          socket dependencies --limit 20 --offset 10"
+    `
+    )
+    expect(`\n   ${stderr}`).toMatchInlineSnapshot(`
+      "
+         _____         _       _        /---------------
+        |   __|___ ___| |_ ___| |_      | Socket.dev CLI ver <redacted>
+        |__   | . |  _| '_| -_|  _|     | Node: <redacted>, API token set: <redacted>
+        |_____|___|___|_,_|___|_|.dev   | Command: \`socket dependencies\`, cwd: <redacted>"
+    `)
+
+    expect(code, 'help should exit with code 2').toBe(2)
+    expect(stderr, 'header should include command (without params)').toContain(
+      '`socket dependencies`'
+    )
+  })
+
+  cmdit(
+    ['dependencies', '--dry-run'],
+    'should require args with just dry-run',
+    async cmd => {
+      const { code, stderr, stdout } = await invokeNpm(entryPath, cmd)
+      expect(stdout).toMatchInlineSnapshot(`"[DryRun]: Bailing now"`)
+      expect(`\n   ${stderr}`).toMatchInlineSnapshot(`
+        "
+           _____         _       _        /---------------
+          |   __|___ ___| |_ ___| |_      | Socket.dev CLI ver <redacted>
+          |__   | . |  _| '_| -_|  _|     | Node: <redacted>, API token set: <redacted>
+          |_____|___|___|_,_|___|_|.dev   | Command: \`socket dependencies\`, cwd: <redacted>"
+      `)
+
+      expect(code, 'dry-run should exit with code 0 if input ok').toBe(0)
+    }
+  )
+})