FAQ

What is a ‘code block’?

A code block is a block of Apex and/or Visualforce code of up to 40,000 lines. Line count is based on production org code and does not include Sandbox code. How many blocks you require on your CodeScan license depends on how many lines of Apex and Visualforce code you have on your Production Org. Example 120K lines of Apex and Visualforce code would equal 3 blocks.

What is a Self-Hosted Single-Project Licence?

A 'Single-Project' Licence allows you to run CodeScan's tests on one SonarQube project and includes a single project key. The amount of CodeScan blocks you need on your license depends on the number of code blocks you have in your code base.

What is an Self-Hosted Multi-Project Licence?

A single ‘Multi-Project License allows you to run tests on one code block across multiple SonarQube projects and Sandboxes. The amount of licences you need depends on the number of code blocks you have in all Production Orgs linked to the Sandboxes you are analysing. A Multi-Project License includes unlimited project keys.

How do I use the Eclipse/IntelliJ/VS Code Plugin?

The Eclipse and IntelliJ plugins are an additional feature. More information is available here

How do I find out how many lines of code I have in my codebase?

You can get this number by installing a trial version of CodeScan and analyzing your project.

You can also try our new Quick Report tool, which allows you to get a quick overview of your project. It includes the ‘Lines of Code’ metric which we use for licensing.

What counts as a line of code and how is it calculated?

A line of code is counted as a non-commented line of code. i.e. not white space. It’s the same value as CodeScan reports in the ‘Lines of Code’ metric in your output.

The lines of code are calculated based on the files that are given to CodeScan from SonarQube. Any files that are excluded from the analysis, for example through parameters like sonar.exclusions, are not counted. Only Apex and VisualForce files are counted, any Javascript/css/etc that is scanned by other plugins are not counted.

You can also try our new Quick Report tool, which allows you to get a quick overview of your project. It includes the ‘Lines of Code’ metric which we use for licensing.

What are CodeScan’s system requirements?

Official requirements for SonarQube can be found here.
Official requirements for Jenkins can be found here.

An example of a typical CodeScan Self-Hosted requires:

  • 2 CPUs (Equivalent to AWS t2.large)
  • 8GB RAM
  • 100GB Disk
  • Modern Linux OS
Note: depending on your use-case, this may be way too much or too little. As SonarQube stores all snapshots for a long time, the data can build up for a large project. Additionally, heavy usage for users would cause more load.

Is CodeScan compatible with my version of SonarQube?

You can check your version against the table below.

SonarQube Version 5.6 6.0 6.1 to 6.6 6.7 7.0 7.1 7.2
CodeScan 4.1
CodeScan 4.0 LTS
CodeScan 3.8
CodeScan 3.6

Can I do an incremental scan on my updated code only?

Yes, however there are a few things to consider:

  • We recommend you scan your entire project and not try to only scan the changes. Many rules in CodeScan rely on all the code being there
  • Keep in mind your CodeScan licence must be based on your entire production org code base.
  • You can use the ‘Leak Period’ feature in SonarQube to find changes in your code base between two periods. The issues that are introduced during this period is displayed on the project page.

Can I export my test results?

Yes you can. To export to a .CSV file, you can use our .CSV plugin.

Mre information is available here.

How many scans can be run?

You can execute the CodeScan license as many times as you want during this period, as long as the total number of lines of each project doesn’t exceed your licensed limit.

Can I use CodeScan with a proxy?

Yes, it just takes a small amount of configuration. You can find a short guide to setting it up here

How can I pay for CodeScan?

Multiple models available including subscription, credit card and annual upfront. See here

What are the differences between CodeScan Self Hosted and Cloud?

To compare the features of CodeScan Cloud and Self Hosted Visit the feature comparison page

Custom Pricing?

Please contact us if you are seeking custom or volume pricing and we’ll get back to you right away.

Any Questions?

We’re happy to answer any questions you have. Please contact our Support Team for assistance.