Скачать или смотреть Resolving the mocha: command not found Error in GitLab CI Runner with Docker

This guide explores the common issue of the GitLab CI Runner failing to recognize `mocha` during tests and provides a step-by-step solution using Docker.
---
This video is based on the question https://stackoverflow.com/q/67723022/ asked by the user 'jeyzorus' ( https://stackoverflow.com/u/7780400/ ) and on the answer https://stackoverflow.com/a/67723982/ provided by the user 'jeyzorus' ( https://stackoverflow.com/u/7780400/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: gitlab ci runner doesnt know mocha

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Troubleshooting mocha Not Found in GitLab CI Runner

When working with CI/CD pipelines, encountering issues with dependencies is not uncommon. One such issue with GitLab CI runners is the notorious 'mocha: command not found' error. This typically arises during the testing phase of a build pipeline where the CI runner is unable to locate the mocha testing framework, despite it being available locally.

In this post, we’ll explore what causes this issue and how to resolve it step-by-step, ensuring your CI/CD process runs smoothly.

Understanding the Problem

In a typical GitLab CI/CD setup, you may define jobs that build your application and run tests. Here's the example provided:

[[See Video to Reveal this Text or Code Snippet]]

During the execution of this job, the CI runner pulls a previously built Docker image and attempts to run tests using mocha:

[[See Video to Reveal this Text or Code Snippet]]

This error indicates that while mocha is installed and functioning correctly on the local machine, the CI runner cannot find it within the environment where the tests are being executed.

The Root Cause

The root cause of this issue often lies in GitLab CI's default behavior of attempting to clone the source code from the repository at the start of the job. In cases such as the one described, where you are testing a built image (likely containing your dependencies already), it is unnecessary for the runner to pull the code again.

This Git checkout action can lead to scenarios where the necessary environment isn't prepared as expected, resulting in commands like mocha not being found during execution.

Step-by-Step Solution

To address this issue, you will need to adjust the Git strategy in your .gitlab-ci.yml file. The solution is to set the GIT_STRATEGY to none. This tells GitLab to skip the checkout of the repository contents, allowing the job to use the previously built image directly.

Here’s how to implement the fix:

Modify the test_api_image job:

[[See Video to Reveal this Text or Code Snippet]]

Explanation of Changes:

GIT_STRATEGY: none: This line is crucial as it prevents GitLab from checking out the code again. Since you are working within a Docker container preconfigured with your dependencies, this strategy effectively sidesteps the problem of missing commands.

Execute your changes: Commit the changes to your .gitlab-ci.yml file. Now, when you run your CI pipeline, the runner should correctly locate mocha and execute your tests without errors.

Conclusion

By adjusting the GIT_STRATEGY in your GitLab CI configuration to none, you can overcome the mocha: command not found error. This solution ensures that your pipeline properly utilizes the built Docker image, allowing for efficient and error-free testing.

Make these adjustments, and you should experience a smoother CI/CD workflow. Happy coding, and may your tests always pass!