Fix issue 241 (handle case where bash is not installed)

[nikita-skobov]

closes #241

execShellScript needs to check for errors in addition to close signals, otherwise it never rejects.

I added tests for resolving and rejecting, but they are pretty bad IMO. Im not well versed in typescript, so I couldn't figure out how to use jest mock functions other than adding // @ts-ignore, so let me know if there's a better way to accomplish this

[nikita-skobov]

@skovhus I got a linting error from using ts-ignore on my tests. Can you review, and tell me what the proper typescript way is to mock child_process?

[skovhus]

Thanks. Just to clarify: the current code handles normal exits fine, but it doesn’t handle if bash doesn’t exist on the path.

There are a few workaround for the Jest mock issue, the best one probably being https://github.com/kulshekhar/ts-jest/blob/master/docs/user/test-helpers.md#mocked

I would avoid mocking for all these cases we can avoid it. This can be done by calling with a command that doesn’t exist for example. For the cases we cannot avoid to mock, then you can use the ts-jest mocked helper.

[nikita-skobov]

I would avoid mocking for all these cases we can avoid it. This can be done by calling with a command that doesn’t exist for example. For the cases we cannot avoid to mock, then you can use the ts-jest mocked helper.

The line within execShellScript

bash-language-server/server/src/util/sh.ts

Line 8 in 016291a

const process = ChildProcess.spawn('bash', args)

contains a child process spawn call of the string 'bash', if we wish to test the function execShellScript we either have to mock child process spawn, or otherwise temporarily delete the bash executable from the users system. If you want to avoid mocks, should I just remove those test cases?

Otherwise a slightly easier approach would be to modify the execShellScript function to optionally take in a command to run instead of just bash, that way when we test it, we can pass in some command that doesnt exist like: dr43hgvfe or whatever.

[skovhus]

Yes, the case bash is not on the path we would still need to mock it. But I like your suggestion of make it parameterized. Then you can make bash the default value of that parameter. 👍

[codecov]

Codecov Report

Merging #242 into master will increase coverage by 0.46%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #242      +/-   ##
==========================================
+ Coverage   73.30%   73.77%   +0.46%     
==========================================
  Files          18       18              
  Lines         547      549       +2     
  Branches       87       87              
==========================================
+ Hits          401      405       +4     
+ Misses        126      125       -1     
+ Partials       20       19       -1     

Impacted Files	Coverage Δ
server/src/util/sh.ts	88.46% <100.00%> (+4.46%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 016291a...689decb. Read the comment docs.