Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scanoss.com/llms.txt

Use this file to discover all available pages before exploring further.

The validation is divided into two parts:

​
Validating the Server and LDB

These tests ensure that the scanning Engine is operational and that version metadata is correctly retrieved from the Knowledge Base (LDB).

​
Create a sample WFP file

echo -e "file=aff32ef2847f81abc62da10769bff43f,421,test\n4=369450fc\n5=bf7226a9\n7=b04dd861\n8=9727e3cd\n10=2152ba16" > sample.wfp

​
Scan the sample WFP file using the local Engine

scanoss sample.wfp

​
Validate the JSON result

scanoss sample.wfp | jq
If the output contains one or more component matches, the Knowledge Base (LDB) is functioning correctly.

​
Validating the API and Load Balancer from a Client

This section verifies that the API, Load Balancer, Engine, and SCANOSS Python client can communicate correctly.

​
Install the SCANOSS Python client

pip3 install scanoss

​
Unpack the acceptance test package

Note: The scanoss-acceptance-test.zip package is provided by SCANOSS as part of the on-premises installation materials. Contact support@scanoss.com if you have not received it. 
unzip scanoss-acceptance-test.zip

​
Run the acceptance test script

bash runTest.sh -u http://<SCANOSS-IP>:4443/api/scan/direct
Replace <SCANOSS-IP> with the hostname or IP address of your API server or Load Balancer.

​
Package and submit the test results

tar cvzf customer-test-results.tgz output
The test results are saved in the output directory. Send the resulting archive (customer-test-results.tgz) to SCANOSS support at support@scanoss.com.