Troubleshooting Code Quality | GitLab Docs
/ Troubleshooting Code Quality Tier : Free, Premium, Ultimate Offering : GitLab.com, GitLab Self-Managed, GitLab Dedicated When working with Code Quality, you might encounter the following issues. Changing the default configuration has no effect A common issue is that the terms Code Quality (GitLab specific) and Code Climate (Engine used by GitLab) are very similar. You must add a .codeclimate.yml file to change the default configuration, not a .codequality.yml file.
If you use the wrong filename, the default .codeclimate.yml is still used. No Code Quality report is displayed in a merge request Code Quality reports from the source or target branch may be missing for comparison on the merge request, so no information can be displayed. Missing report on the source branch can be due to: Use of the REPORT_STDOUT environment variable , no report file is generated and nothing displays in the merge request.
Missing report on the target branch can be due to: Newly added Code Quality job in your .gitlab-ci.yml . Your pipeline is not set to run the Code Quality job on your target branch. Commits are made to the default branch that do not run the Code Quality job. The artifacts:expire_in CI/CD setting can cause the Code Quality artifacts to expire faster than desired. Verify the presence of report on the base commit by obtaining the base_sha using the merge request API and use the pipelines API with the sha attribute to check if pipelines ran.
No Code Quality symbol in the changes view If no symbol is displayed in the changes view , ensure that the location.path in the code quality report: Is using a relative path to the file containing the code quality violation. Is not prefixed with ./ . For example, the path should be somedir/file1.rb instead of ./somedir/file1.rb . Only a single Code Quality report is displayed, but more are defined Code Quality automatically combines multiple reports .
RuboCop errors When using Code Quality jobs on a Ruby project, you can encounter problems running RuboCop. For example, the following error can appear when using either a very recent or very old version of Ruby: /usr/local/bundle/gems/rubocop-0.52.1/lib/rubocop/config.rb:510:in `check_target_ruby': Unknown Ruby version 2.7 found in `.ruby-version`. (RuboCop::ValidationError) Supported versions: 2.1, 2.2, 2.3, 2.4, 2.5 The default RuboCop version in the check engine doesn’t support the Ruby version in use.
To use a custom version of RuboCop that supports the version of Ruby used by the project , you can override the configuration through a .codeclimate.yml file created in the project repository. For example, to specify using RuboCop release 0.67 : yaml version : "2" plugins : rubocop : enabled : true channel : rubocop-0-67 No Code Quality appears on merge requests when using custom tool If your merge requests do not show any Code Quality changes when using a custom tool, ensure that all line properties in the JSON are integer .
Error: Could not analyze code quality You might get the error: shell error: ( CC::CLI::Analyze::EngineFailure ) engine pmd ran for 900 seconds and was killed Could not analyze code quality for the repository at /code If you enabled any of the Code Climate plugins, and the Code Quality CI/CD job fails with this error message, it’s likely the job takes longer than the default timeout of 900 seconds: To work around this problem, set TIMEOUT_SECONDS to a higher value in your .gitlab-ci.yml file.
For example: yaml code_quality : variables : TIMEOUT_SECONDS : 3600 Error: x509: certificate signed by unknown authority If you set the CODE_QUALITY_IMAGE to an image that is hosted in a Docker registry which uses a TLS certificate that is not trusted, such as a self-signed certificate, you might see the following error: shell $ docker pull --quiet " $CODE_QUALITY_IMAGE " Error response from daemon: Get https://gitlab.example.com/v2/: x509: certificate signed by unknown authority To fix this, configure the Docker daemon to trust certificates by putting the certificate inside of the /etc/docker/certs.d directory.
This Docker daemon is exposed to the subsequent Code Quality Docker container in the GitLab Code Quality template and should be exposed to any other containers in which you want to have your certificate configuration apply. Docker If you have access to GitLab Runner configuration, add the directory as a volume mount . Replace gitlab.example.com with the actual domain of the registry. Example: toml [[ runners ]] ... executor = "docker" [ runners . docker ] ... privileged = true volumes = [ "/cache" , "/etc/gitlab-runner/certs/gitlab.example.com.crt:/etc/docker/certs.d/gitlab.example.com/ca.crt:ro" ] Kubernetes If you have access to GitLab Runner configuration and the Kubernetes cluster, you can mount a ConfigMap .
Replace gitlab.example.com with the actual domain of the registry. Create a ConfigMap with the certificate: shell kubectl create configmap registry-crt --namespace gitlab-runner --from-file /etc/gitlab-runner/certs/gitlab.example.com.crt Update GitLab Runner config.toml to specify the ConfigMap: toml [[ runners ]] ... executor = "kubernetes" [ runners . kubernetes ] image = "alpine:3.12" privileged = true [[ runners . kubernetes . volumes . config_map ]] name = "registry-crt" mount_path = "/etc/docker/certs.d/gitlab.example.com/ca.crt" sub_path = "gitlab.example.com.crt" Failed to load Code Quality report The Code Quality report can fail to load when there are issues parsing data from the artifact file.
To gain insight into the errors, you can execute a GraphQL query using the following steps: Go to the pipeline details page. Append .json to the URL. Copy the iid of the pipeline. Go to the interactive GraphQL explorer . Run the following query: graphql { project ( fullPath : "<fullpath-to-your-project>" ) { pipeline ( iid : "<iid>" ) { codeQualityReports { count nodes { line description path fingerprint severity } pageInfo { hasNextPage hasPreviousPage startCursor endCursor } } } } } No report artifact is created With certain Runner configurations, the Code Quality scanning job may not have access to your source code.
If this happens, the gl-code-quality-report.json artifact isn’t created. To resolve this issue, either: Use the documented Runner configuration for Docker-in-Docker , which uses privileged mode instead of Docker socket binding. Apply the community workaround in issue 32027 if you wish to continue using Docker socket binding. Was this page helpful?