WS Cleanup Tool
Project description
WhiteSource Projects Cleanup Tool
Tool to archive projects from White Source Application.
- The tool generates reports for each project in WhiteSource Organization in 2 modes:
- By stating OperationMode=FilterProjectsByUpdateTime and how many days to keep (-r/ ToKeep=)
- By stating OperationMode=FilterProjectsByLastCreatedCopies and how many copies to keep (-r/ ToKeep=)
- The reports are saved in a designated location in form of: [ReportsDir]/[PRODUCT NAME]/[PROJECT NAME]/[REPORT NAME]
- -y true / DryRun=True flag can be used to review the outcome of a run. It will NOT delete any project nor create reports
- By default, the tool generates all possible project level reports. It is possible to state which reports to generate (-t / Reports/).
- Full flag list is available below
- The tool can be configured in 2 modes:
- By configuring params.config on the executed dir or passing a path to file in the same format.
- By setting command switched as specified in the usage below.
Supported Operating Systems
- Linux (Bash): CentOS, Debian, Ubuntu, RedHat
- Windows (PowerShell): 10, 2012, 2016
Pre-requisites
- Python 3.7+
Permissions
- The user used to execute the tool has to have "Organization Administrator" or "Product Administrator" on all the maintained products and "Organization Auditor" permissions.
- It is recommended to use a service user.
Installation and Execution from PyPi (recommended):
- Install by executing:
pip install ws-cleanup-tool
- Configure the appropriate flags either by using the command switches described below or in
params.config
. - Execute the tool (
ws_cleanup_tool ...
).
Installation and Execution from GitHub:
- Download and unzip ws-cleanup-tool.zip
- Install requirements:
pip install -r requirements.txt
- Edit the param.config file with the appropriate parameters
- Execute:
python cleanup_tool.py <CONFIG_FILE>
Parameters Description (params.config)
- IncludedProductTokens - list of included products
- ExcludedProductTokens - list of excluded products
- WsUrl - URL of WhiteSource Application (optional)
- UserKey WhiteSource User Key
- OrgToken Organization Token
- DryRun - If True, tool will not create reports and delete projects
- SkipReportGeneration - Whether to skip report generation
- SkipProjectDeletion - whether to skip project deletion
- DaysToKeep - How many days since last update of a project to keep
- Reports - Report names to run
- ReportsDir - Directory to save reports in
- ProjectParallelismLevel - Number of parallel processes to generate reports.
Full Usage flags:
usage: ws_cleanup_tool [-h] -u WS_USER_KEY -k WS_TOKEN [-a WS_URL] [-t REPORT_TYPES] [-m {FilterProjectsByUpdateTime,FilterProjectsByLastCreatedCopies}] [-o ARCHIVE_DIR] [-e EXCLUDED_PRODUCT_TOKENS] [-i INCLUDED_PRODUCT_TOKENS]
[-g ANALYZED_PROJECT_TAG] [-r TO_KEEP] [-p PROJECT_PARALLELISM_LEVEL] [-y DRY_RUN]
WS Cleanup Tool
optional arguments:
-h, --help show this help message and exit
-u WS_USER_KEY, --userKey WS_USER_KEY
WS User Key
-k WS_TOKEN, --token WS_TOKEN
WS Organization Key
-a WS_URL, --wsUrl WS_URL
WS URL
-t REPORT_TYPES, --ReportTypes REPORT_TYPES
Report Types to generate (comma seperated list)
-m {FilterProjectsByUpdateTime,FilterProjectsByLastCreatedCopies}, --operation_mode {FilterProjectsByUpdateTime,FilterProjectsByLastCreatedCopies}
Archive operation method
-o ARCHIVE_DIR, --out ARCHIVE_DIR
Output directory
-e EXCLUDED_PRODUCT_TOKENS, --excludedProductTokens EXCLUDED_PRODUCT_TOKENS
Excluded list
-i INCLUDED_PRODUCT_TOKENS, --IncludedProductTokens INCLUDED_PRODUCT_TOKENS
Included list
-g ANALYZED_PROJECT_TAG, --AnalyzedProjectTag ANALYZED_PROJECT_TAG
Allows only analyze whether to archive if project contains a specific K:V tag
-r TO_KEEP, --ToKeep TO_KEEP
Number of days to keep in FilterProjectsByUpdateTime or number of copies in FilterProjectsByLastCreatedCopies
-p PROJECT_PARALLELISM_LEVEL, --ProjectParallelismLevel PROJECT_PARALLELISM_LEVEL
Project parallelism level
-y DRY_RUN, --DryRun DRY_RUN
Whether to run the tool without performing anything
Examples:
# Performing dry run to check which project will get deleted if command will be executed this way:
ws_cleanup_tool -r 30 -m FilterProjectsByUpdateTime -u <USER_KEY> -t <ORG_TOKEN> -y true
# keep last 60 days on each product omitting product token x from analyze:
ws_cleanup_tool -r 60 -m FilterProjectsByUpdateTime -u <USER_KEY> -t <ORG_TOKEN> -e x
# Keep 2 of the newest projects in each product token x and y:
ws_cleanup_tool -r 2 -m FilterProjectsByLastCreatedCopies -u <USER_KEY> -t <ORG_TOKEN> -i x,y
# Only analyze project that has k1:v1 comment and keep the newest project in each product token:
ws_cleanup_tool -r 1 -m FilterProjectsByLastCreatedCopies -u <USER_KEY> -t <ORG_TOKEN>
note: The optimal number is derived from the size of the environment, WhiteSource scope size, (memory and CPU) allocated for the server and runtime time constraints.
Project details
Release history Release notifications | RSS feed
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
Close
Hashes for ws_cleanup_tool-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 81c20a94fcb40d74bc382f4df490870131d2f8850148bb6d6239f57cb88699ee |
|
MD5 | 879fe76b89adbcab17c69497b8ea3374 |
|
BLAKE2b-256 | a9a19fe7c80965f415a3a0cfe1b36e64d18d2455e48c8b184b8432c31d23e679 |