|
|
|
|
|
|
|
# ORT Setup and execution
|
|
|
|
|
|
|
|
This is the summary of the current setup of ORT and required tools on the Eclipse VM at `ort-vm1.eclipse.org`.
|
|
|
|
|
|
|
|
|
|
|
|
## VM setup
|
|
|
|
|
|
|
|
Main directories:
|
|
|
|
* All **applications** (scancode, ort) are in `/ort/`: `/ort/scancode-toolkit-30.1.0/`, `/ort/ort/`.
|
|
|
|
* **Configuration** is cloned in `/ort/eclipsefdn-ort/`.
|
|
|
|
* **Project code** is cloned in `/data/projects/`.
|
|
|
|
* **Results** are stored in `/data/results/`.
|
|
|
|
|
|
|
|
Notes:
|
|
|
|
* We install the software as `root`, but chown and execute it as user `ort`.
|
|
|
|
* All operations (configuration, runs..) are now meant to be executed as `ort`.
|
|
|
|
|
|
|
|
|
|
|
|
## Start a run
|
|
|
|
|
|
|
|
Runs can last for a long time (e.g. several hours). It is highly recommended to execute runs with `nohup` or `screen`.
|
|
|
|
|
|
|
|
### Connect to the VM host
|
|
|
|
|
|
|
|
SSH into `ort-vm1.eclipse.org`.
|
|
|
|
|
|
|
|
If you don't have an account, please [submit an issue](https://gitlab.eclipse.org/eclipsefdn/emo-team/eclipsefdn-ort/-/issues) and provide us with your public ssh key.
|
|
|
|
|
|
|
|
### Clone your project
|
|
|
|
|
|
|
|
If the project ou want to run is not already cloned, then clone it:
|
|
|
|
|
|
|
|
```
|
|
|
|
ort@ort-vm1:~$ cd /data/projects/
|
|
|
|
ort@ort-vm1:/data/projects$ ls
|
|
|
|
acumos-nexus-client jgit kie-wb-distributions org.eclipse.epsilon org.eclipse.tracecompass smartclide-broker smartclide-context tycho
|
|
|
|
che kie-wb-common org.eclipse.emf.ecp.core org.eclipse.sirius smartclide-api-gateway smartclide-cicd theia
|
|
|
|
ort@ort-vm1:/data/projects$ git clone https://git.eclipse.org/r/cdt/org.eclipse.cdt
|
|
|
|
Cloning into 'org.eclipse.cdt'...
|
|
|
|
|
|
|
|
[SNIP]
|
|
|
|
```
|
|
|
|
|
|
|
|
If it's already there, simply update (pull) it.
|
|
|
|
|
|
|
|
### Execute project run
|
|
|
|
|
|
|
|
There is a single script to run the pre-configured analysis, located in `/ort/eclipsefdn-ort/scripts/`. its usage is as follows:
|
|
|
|
|
|
|
|
```
|
|
|
|
Usage: /ort/eclipsefdn-ort/scripts/run_ort.sh <dir_project> <dir_results>
|
|
|
|
```
|
|
|
|
|
|
|
|
To analyse a project simply execute it with the path to the project and results directory:
|
|
|
|
|
|
|
|
```
|
|
|
|
ort@ort-vm1:~$ time /ort/eclipsefdn-ort/scripts/run_ort.sh /data/projects/org.eclipse.cdt/ /data/results/
|
|
|
|
Start scan at 2022-03-07 09:16
|
|
|
|
- Using ort from [ort].
|
|
|
|
- Log written to [/data/results/org.eclipse.cdt_202203070916.log].
|
|
|
|
- Working on project [/data/projects/org.eclipse.cdt/].
|
|
|
|
|
|
|
|
* Start analyzer at 2022-03-07 09:16
|
|
|
|
|
|
|
|
[SNIP]
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
The scripts logs all output to `${DIR_RESULTS}/<project>_<date>.log`, and the analysis result files are stored in `${DIR_RESULTS}/<project>_<date>/`.
|
|
|
|
|
|
|
|
An example of successful run looks like this:
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
``` |
|
|
|
\ No newline at end of file |