The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

CodeSonar Plugin

codesonar: CodeSonar

  • conditions
    Choose the condition you want CodeSonar to use for build verification
      Array / List of Nested Choice of Objects
    • warningCountIncreaseNewOnly

      Condition will trigger the warranted result if the amount of warnings that did not exist until the current analysis is exceeded by more than the designated percentage.

      Maximum percentage increase - if the percentage of warnings exceed this amount it will mark build with the desired result [default 5.0]

      Mark build as - the desired result if the condition is triggered.

      • percentage : String (optional)
      • warrantedResult : String (optional)
    • cyclomaticComplexity

      Condition will change the result of the build if the cyclomatic complexity of procedures exceeds the preset value.

      Cyclomatic complexity limit - The procedures with cyclomatic complexity that exceeds this value will change the build result. [default 30]

      Mark build as - the desired result if the condition is triggered.

      • maxCyclomaticComplexity : int (optional)
      • warrantedResult : String (optional)
    • redAlerts

      Condition will change the result of the build if the amount of red alerts exceed the predefined value.

      Maximum amount of alerts - the maximum allowed amount of red alerts [default 1]

      Mark build as - the desired result if the condition is triggered.

      • alertLimit : int (optional)
      • warrantedResult : String (optional)
    • warningCountAbsoluteSpecifiedScoreAndHigher

      Condition will change the result of the build if the number of warnings above the predefined rank is greater then the maximum allowable.

      Rank of warnings - only warnings that are at or above this rank will be checked. [default 56]

      Maximum warnings - if the number of warnings at or above the specified score exceed this amount it will mark build with the desired result [default 20]

      Mark build as - the desired result if the condition is triggered.

      • rankOfWarnings : int
      • warningCountThreshold : int
      • warrantedResult : String (optional)
    • warningCountIncreaseOverall

      Condition will change the result of the build if the amount of warnings the analysis produces is greater than the preset percentage.

      Maximum percentage increase - if the percentage of warnings exceed this amount it will mark build with the desired result [default 5.0]

      Mark build as - the desired result if the condition is triggered.

      • percentage : String
      • warrantedResult : String (optional)
    • warningCountIncreaseSpecifiedScoreAndHigher

      Condition will change the result of the build if the percentage of warnings bellow the predefined rank increases above a certain percentage.

      Rank of warnings - Only warnings that are bellow this rank will be checked. [default 30]

      Maximum percentage increase - if the percentage of warnings exceed this amount it will mark build with the desired result [default 5.0]

      Mark build as - the desired result if the condition is triggered.

      • rankOfWarnings : int
      • warningPercentage : String
      • warrantedResult : String (optional)
    • yellowAlerts

      Condition will change the result of the build if the amount of yellow alerts exceed the predefined value.

      Maximum amount of alerts - the maximum allowed amount of yellow alerts [default 1]

      Mark build as - the desired result if the condition is triggered.

      • alertLimit : int (optional)
      • warrantedResult : String (optional)
  • protocol : String
    Choose http or https
  • hubAddress : String
    IP address of the CodeSonar hub
  • projectName : String
    The name of the project. All characters allowed
  • credentialId : String
    CodeSonar credentials
  • visibilityFilter : String (optional)
    The visibility filter is used to filter which warnings that are used for the conditions. It matches the items under "Visible Warnings" under an analysis in CodeSonar. Please use the ID number of the filter you want to use. You can find the ID numbers under this url hub_address/savedsearches.html?filter=3&ssdomain=0&ssearchsgrd=Ay_0D_BTl3BTl3AgBg
  • aid : String (optional)
    Use this attribute to override analysis id
  • serverCertificateCredentialId : String (optional)
    Jenkins Credentials containing HTTPS Server certificate of CodeSonar Hub. Credentials must be of type Secret File and must include a X509 certificate.
  • socketTimeoutMS : int (optional)
    Use this attribute to override default connection timeout.

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.