Skip to content

Latest commit

 

History

History
53 lines (31 loc) · 2.22 KB

README.md

File metadata and controls

53 lines (31 loc) · 2.22 KB
Raw

sca-codeinsight-reports-installer

The sca-codeinsight-reports-installer repository allows users to easily install available reports into the Code Insight report framework

Prerequisites

Python Requirements

A minimum vesion of python 3.5 is required to run this script. No additional python modules should be required to run this program

Git Requirements

This script will automatically pull multiple resositories from github so git is required.

Suggestion

Clone or unzip this repository into the custom_report_scripts folder within your Code Insight installation. By default this report will attempt to use that folder for the installation location for all other reports. Otherwise the -installDir option will always be required when running this script subsequent times.

Usage

The script accepts four arguments to be supplied by the user

  • The Code Insight installation directory
  • The URL/FQDN of the Code Insight system
  • An admin authorization token to be used when registering the report into Code Insight (Required)
  • The path to a pem file for any servers with a self signed certifcate for SSL (Optional)

To run the script on a windows system

python install_reports.py -server http(s)://FQDN:port -token ${Admin Auth Token} -installDir $(CodeInsight Installation Directory}

To run the script on a Linux system

python3 install_reports.py -server http(s)://FQDN:port -token ${Admin Auth Token} -installDir $(CodeInsight Installation Directory}

The install_reports.py script will

  • Verify the installation directory supplied or if the current working directory is a valid Code Insight installation
  • Create the custom_report_scripts directory if required
  • Determine if a server.properties.json file exists and attempt to create this file based on the supplied argumetns if possible.
  • Recursivly clone the supplied report repositories
  • Install any needed python dependencies using the requiremetns.txt file
    • sudo user permissions maybe required on linux systems
  • Register the report with Code Insight
  • Display the current versions of all of the reports installed by the script
  • Remove the Admin Authorization token from the server.properties.json file

License

MIT