fix: can ignore EEXISTS and exit with 0 (#23)

Signed-off-by: dankeboy36 <[email protected]>

Author: dankeboy36

README.md

@@ -9,6 +9,7 @@ Get Arduino Tools (`gat`) is a CLI that helps you easily download various Arduin
 - [Arduino CLI](https://github.com/arduino/arduino-cli)
 - [Arduino Language Server](https://github.com/arduino/arduino-language-server)
 - [Arduino Firmware Uploader](https://github.com/arduino/arduino-fwuploader)
+- [Arduino Lint](https://github.com/arduino/arduino-lint)
 - [`clangd`](https://github.com/arduino/clang-static-binaries)
 - [`clang-format`](https://github.com/arduino/clang-static-binaries)
 
@@ -32,7 +33,7 @@ gat get <tool> <version> [options]
 
 #### Arguments
 
-- `<tool>`: The tool you want to download. Can be one of: `arduino-cli`, `arduino-language-server`, `arduino-fwuploader`, `clangd`, `clang-format`.
+- `<tool>`: The tool you want to download. Can be one of: `arduino-cli`, `arduino-language-server`, `arduino-fwuploader`, `arduino-lint`, `clangd`, `clang-format`.
 - `<version>`: The version of the tool you want to download.
 
 #### Options
@@ -41,6 +42,7 @@ gat get <tool> <version> [options]
 - `-p, --platform <platform>`: Platform (default: current platform).
 - `-a, --arch <arch>`: Architecture (default: current architecture).
 - `-f, --force`: Force download to overwrite existing files (default: false).
+- `--ok-if-exists`: If the tool already exists and is executable, skip download and exit with code 0.
 - `--verbose`: Enables verbose output (default: false).
 - `--silent`: Disables the progress bar (default: false).
 

package-lock.json

@@ -27,6 +27,11 @@ function parse(args) {
     .option('-p, --platform <platform>', 'Platform', process.platform)
     .option('-a, --arch <arch>', 'Architecture', process.arch)
     .option('-f, --force', 'Force download to overwrite existing files', false)
+    .option(
+      '--ok-if-exists',
+      'If the tool already exists, skip download and exit with code 0',
+      false
+    )
     .option('--verbose', 'Enables the verbose output', false)
     .option('--silent', 'Disables the progress bar', false)
     .description('Get an Arduino tool')
@@ -69,8 +74,13 @@ function parse(args) {
       } catch (err) {
         log('Failed to download tool', err)
         console.log(err?.message || err)
-        if (err.code === 'EEXIST' && options.force !== true) {
-          return program.error('Use --force to overwrite existing files')
+        if (err.code === 'EEXIST') {
+          if (options.okIfExists) {
+            log('Tool already exists and is executable, skipping download')
+            return
+          } else if (options.force !== true) {
+            return program.error('Use --force to overwrite existing files')
+          }
         }
         return program.error(err?.message || err)
       }

src/cli.js

@@ -23,39 +23,50 @@ const clangToolExpectVersion = async (toolPath, expected) => {
 }
 
 describe('cli', () => {
-  /** @type {CliTestParams[]} */
-  const params = [
-    {
+  /** @type {Record<import('./tools').Tool, CliTestParams>} */
+  const params = {
+    'arduino-cli': {
       tool: 'arduino-cli',
-      version: '1.1.1',
+      version: '1.2.2',
       expectVersion: arduinoToolExpectVersion,
     },
-    {
+    'arduino-fwuploader': {
       tool: 'arduino-fwuploader',
       version: '2.4.1',
       expectVersion: arduinoToolExpectVersion,
     },
-    {
+    'arduino-language-server': {
       tool: 'arduino-language-server',
-      version: '0.7.6',
+      version: '0.7.7',
       expectVersion: async (toolPath) => {
         // The Arduino LS requires the CLI and clangd. The assertion expects a failure.
         const stdout = await execFile(toolPath, ['version'], true)
         expect(stdout).toContain('Path to ArduinoCLI config file must be set')
       },
     },
-    {
+    clangd: {
       tool: 'clangd',
       version: '14.0.0',
       expectVersion: clangToolExpectVersion,
     },
-    {
+    'clang-format': {
       tool: 'clang-format',
       version: '14.0.0',
       expectVersion: clangToolExpectVersion,
     },
-  ]
-  params.map(({ tool, version, expectVersion }) =>
+    'arduino-lint': {
+      tool: 'arduino-lint',
+      version: '1.3.0',
+      expectVersion: async (toolPath) => {
+        // The Arduino Lint requires the CLI to be in a library folder, for example
+        // _This will automatically detect the project type and check it against the relevant rules._
+        // https://arduino.github.io/arduino-lint/latest/#getting-started
+        const stdout = await execFile(toolPath, ['version'], true)
+        expect(stdout).toContain('PROJECT_PATH argument version does not exist')
+      },
+    },
+  }
+  Object.values(params).map(({ tool, version, expectVersion }) =>
     it(`should get the ${tool}`, async () => {
       const { path: tempDirPath } = await tmp.dir({
         keep: false,

src/cli.slow-test.js

@@ -51,6 +51,7 @@ describe('cli', () => {
       silent: false,
       verbose: false,
       onProgress: expect.any(Function),
+      okIfExists: false,
     })
 
     expect(exitSpy).not.toHaveBeenCalled()
@@ -216,4 +217,39 @@ describe('cli', () => {
       expect.objectContaining({ silent: true })
     )
   })
+
+  it('should ignore EEXIST if --ok-if-exists is set', async () => {
+    jest
+      .mocked(getTool)
+      .mockRejectedValueOnce(
+        Object.assign(new Error('my error'), { code: 'EEXIST' })
+      )
+
+    parse([
+      'node',
+      'script.js',
+      'get',
+      'arduino-cli',
+      '1.1.1',
+      '--ok-if-exists',
+    ])
+
+    await waitFor(() => expect(mockLog).toHaveBeenCalledWith('my error'))
+
+    expect(exitSpy).not.toHaveBeenCalled()
+  })
+
+  it('should rethrow EEXIST if --ok-if-exists is not but --force is set', async () => {
+    jest
+      .mocked(getTool)
+      .mockRejectedValueOnce(
+        Object.assign(new Error('my error'), { code: 'EEXIST' })
+      )
+
+    parse(['node', 'script.js', 'get', 'arduino-cli', '1.1.1', '--force'])
+
+    await waitFor(() => expect(mockLog).toHaveBeenCalledWith('my error'))
+
+    expect(exitSpy).toHaveBeenCalledWith(1)
+  })
 })

src/cli.test.js

@@ -2,6 +2,7 @@ const arduinoTools = [
   'arduino-cli',
   'arduino-language-server',
   'arduino-fwuploader',
+  'arduino-lint',
 ] as const
 const clangTools = ['clangd', 'clang-format'] as const