Add tests for basic formatting with shfmt

Author: chris-reeves

server/src/__tests__/config.test.ts

@@ -13,6 +13,7 @@ describe('ConfigSchema', () => {
         "logLevel": "info",
         "shellcheckArguments": [],
         "shellcheckPath": "shellcheck",
+        "shfmtPath": "shfmt",
       }
     `)
   })
@@ -25,6 +26,7 @@ describe('ConfigSchema', () => {
         includeAllWorkspaceSymbols: true,
         shellcheckArguments: ' -e SC2001  -e SC2002 ',
         shellcheckPath: '',
+        shfmtPath: 'myshfmt',
       }),
     ).toMatchInlineSnapshot(`
       {
@@ -41,6 +43,7 @@ describe('ConfigSchema', () => {
           "SC2002",
         ],
         "shellcheckPath": "",
+        "shfmtPath": "myshfmt",
       }
     `)
   })
@@ -67,12 +70,14 @@ describe('getConfigFromEnvironmentVariables', () => {
         "logLevel": "info",
         "shellcheckArguments": [],
         "shellcheckPath": "shellcheck",
+        "shfmtPath": "shfmt",
       }
     `)
   })
   it('preserves an empty string', () => {
     process.env = {
       SHELLCHECK_PATH: '',
+      SHFMT_PATH: '',
       EXPLAINSHELL_ENDPOINT: '',
     }
     const { config } = getConfigFromEnvironmentVariables()
@@ -86,6 +91,7 @@ describe('getConfigFromEnvironmentVariables', () => {
         "logLevel": "info",
         "shellcheckArguments": [],
         "shellcheckPath": "",
+        "shfmtPath": "",
       }
     `)
   })
@@ -94,6 +100,7 @@ describe('getConfigFromEnvironmentVariables', () => {
     process.env = {
       SHELLCHECK_PATH: '/path/to/shellcheck',
       SHELLCHECK_ARGUMENTS: '-e SC2001',
+      SHFMT_PATH: '/path/to/shfmt',
       EXPLAINSHELL_ENDPOINT: 'localhost:8080',
       GLOB_PATTERN: '*.*',
       BACKGROUND_ANALYSIS_MAX_FILES: '1',
@@ -113,6 +120,7 @@ describe('getConfigFromEnvironmentVariables', () => {
           "SC2001",
         ],
         "shellcheckPath": "/path/to/shellcheck",
+        "shfmtPath": "/path/to/shfmt",
       }
     `)
   })

server/src/__tests__/server.test.ts

@@ -85,6 +85,7 @@ describe('server', () => {
           ],
         },
         "definitionProvider": true,
+        "documentFormattingProvider": true,
         "documentHighlightProvider": true,
         "documentSymbolProvider": true,
         "hoverProvider": true,

server/src/shfmt/__tests__/index.test.ts

@@ -0,0 +1,93 @@
+import { TextDocument } from 'vscode-languageserver-textdocument'
+
+import { FIXTURE_DOCUMENT, FIXTURE_FOLDER } from '../../../../testing/fixtures'
+import { Logger } from '../../util/logger'
+import { Formatter } from '../index'
+
+jest.spyOn(Logger.prototype, 'log').mockImplementation(() => {
+  // noop
+})
+const loggerWarn = jest.spyOn(Logger.prototype, 'warn')
+
+const FIXTURE_DOCUMENT_URI = `file://${FIXTURE_FOLDER}/foo.sh`
+function textToDoc(txt: string) {
+  return TextDocument.create(FIXTURE_DOCUMENT_URI, 'bar', 0, txt)
+}
+
+async function getFormattingResult({
+  document,
+  executablePath = 'shfmt',
+}: {
+  document: TextDocument
+  executablePath?: string
+}): Promise<[Awaited<ReturnType<Formatter['format']>>, Formatter]> {
+  const formatter = new Formatter({
+    executablePath,
+  })
+  const result = await formatter.format(document)
+  return [result, formatter]
+}
+
+describe('formatter', () => {
+  it('defaults canFormat to true', () => {
+    expect(new Formatter({ executablePath: 'foo' }).canFormat).toBe(true)
+  })
+
+  it('should set canFormat to false when formatting fails', async () => {
+    const [result, formatter] = await getFormattingResult({
+      document: textToDoc(''),
+      executablePath: 'foo',
+    })
+
+    expect(result).toEqual([])
+
+    expect(formatter.canFormat).toBe(false)
+    expect(loggerWarn).toBeCalledWith(
+      expect.stringContaining(
+        'Shfmt: disabling formatting as no executable was found at path',
+      ),
+    )
+  })
+
+  it('should format when shfmt is present', async () => {
+    const [result] = await getFormattingResult({ document: FIXTURE_DOCUMENT.SHFMT })
+    expect(result).toMatchInlineSnapshot(`
+      [
+        {
+          "newText": "#!/bin/bash
+      set -ueo pipefail
+
+      if [ -z "$arg" ]; then
+      	echo indent
+      fi
+
+      echo binary &&
+      	echo next line
+
+      case "$arg" in
+      a)
+      	echo case indent
+      	;;
+      esac
+
+      echo space redirects >/dev/null
+
+      function next() {
+      	echo line
+      }
+      ",
+          "range": {
+            "end": {
+              "character": 2147483647,
+              "line": 2147483647,
+            },
+            "start": {
+              "character": 0,
+              "line": 0,
+            },
+          },
+        },
+      ]
+    `)
+  })
+})

testing/fixtures.ts

@@ -34,6 +34,7 @@ export const FIXTURE_URI = {
     'shellcheck',
     'shell-directive.bash',
   )}`,
+  SHFMT: `file://${path.join(FIXTURE_FOLDER, 'shfmt.sh')}`,
   SOURCING: `file://${path.join(FIXTURE_FOLDER, 'sourcing.sh')}`,
   SOURCING2: `file://${path.join(FIXTURE_FOLDER, 'sourcing2.sh')}`,
   RENAMING: `file://${path.join(FIXTURE_FOLDER, 'renaming.sh')}`,

testing/fixtures/shfmt.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+set -ueo pipefail
+
+if [ -z "$arg" ]; then
+echo indent
+fi
+
+echo binary&&
+echo next line
+
+case "$arg" in
+a)
+echo case indent
+;;
+esac
+
+echo space redirects>  /dev/null
+
+function next(){
+echo line
+}