Skip to main content

Mend Ignore Alerts

Project description

Logo

License GitHub release WS Ignore Alerts Build and Publish Python 3.6

Ignore Future Alerts

ws_ignore_alerts.py is a utility for automated ignoring alerts in the newly created WS project, which is a version of the same customer's product, according to the previously ignored alerts in the baseline WS project. Once a new UA scan has finished, and a new project has been created, the utility can be launched as part of the pipeline for automated ignoring alerts. There are three options for use:

  • using a baseline project token and destination project name defined by the user - baselineProjectToken and destProjectName (optional: destProjectVersion). Might work with different products.
  • using a baseline project token and destination project token defined by the user - baselineProjectToken and destProjectToken. Might work with different products.
  • using the default behavior, without providing baseline and destination projects' data. In this case, the destination project is a latest project of the certain product and baseline project is one before the latest project of the same product. Only works within a certain product. The ignored alerts will be pulled from the baseline project, and the same alerts will be ignored in the destination project.

Supported Operating Systems

  • Linux (Bash): CentOS, Debian, Ubuntu, RedHat
  • Windows (PowerShell): 10, 2012, 2016

Prerequisites

  • Python 3.7 or above

Installation and Execution from PyPi:

  1. Install by executing: pip install ws-ignore-alerts
  2. Configure the appropriate parameters either by using the command line or in params.config.
  3. Execute the tool (ws_ignore_alerts ...).

Installation and Execution from GitHub:

  1. Download and unzip ws-ignore-alerts.zip
  2. Install requirements: pip install -r requirements.txt
  3. Configure the appropriate parameters either by using the command line or params.config.
  4. Execute: python ignore_alerts.py <CONFIG_FILE>

Execution Examples

From the command line:

  • python ws_ignore_alerts.py -u $wsUrl -k $userKey -o $orgToken -p $productToken -b $baselineProjectToken -n $destProjectName -v $destProjectVersion -t $destProjectToken -d $destProductToken

Using a config file:

  • python ws_ignore_alerts.py

Note: If more than one version of Python installed on the target machine, use the appropriate executables for the installation and the execution (pip3 and python3 respectively)

Configuration Parameters

===============================================================================================================
| Group         | Parameter            | Description                                                          |
===============================================================================================================
| DEFAULT       | wsUrl                | WhiteSource server URL. Can be found under the 'Integrate' tab in    |   
|               |                      | your WhiteSource organization.                                       |
---------------------------------------------------------------------------------------------------------------
| DEFAULT       | userKey              | WhiteSource User Key. Can be found under the 'Profile' section in    |
|               |                      | your WhiteSource organization.                                       |
---------------------------------------------------------------------------------------------------------------
| DEFAULT       | orgToken             | WhiteSource API Key. Can be found under the 'Integrate' tab in your  |
|               |                      | your WhiteSource organization.                                       |
---------------------------------------------------------------------------------------------------------------
| DEFAULT       | productToken         | WhiteSource Product Token. Can be found under the 'Integrate' tab    |  
|               |                      | in your WhiteSource organization.                                    |
---------------------------------------------------------------------------------------------------------------
| DEFAULT       | baselineProjectToken | Token of the WhiteSource project the ignored alerts are pulled from. |  
|               |                      | Can be found under the settings icon within a particular project.    |
---------------------------------------------------------------------------------------------------------------
| DEFAULT       | destProjectName      | Name of the WhiteSource project where the alerts will be ignored.    |  
---------------------------------------------------------------------------------------------------------------
| DEFAULT       | destProjectVersion   | Version of the WhiteSource project where the alerts will be ignored. |  
---------------------------------------------------------------------------------------------------------------
| DEFAULT       | destProjectToken     | Token of the WhiteSource project where the alerts will be ignored.   | 
---------------------------------------------------------------------------------------------------------------
| DEFAULT       | destProductToken     | Token of the WhiteSource product where the alerts will be ignored.   | 
===============================================================================================================

Author

WhiteSource Software ©

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

ws_ignore_alerts-0.2.4-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file ws_ignore_alerts-0.2.4-py3-none-any.whl.

File metadata

File hashes

Hashes for ws_ignore_alerts-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 366c9dc37540302ec6cdbe8cffa7764c73a4c4c87e62dff94543b6f317efcf7a
MD5 9530068c20746d814b7b5fc28807c7c6
BLAKE2b-256 5aa6aee209acc2f085f48b70d244c10737e40e23c8ca11f4cca49a5f61e9d750

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page