how to get scan result out of container and to the local system

[roshvin]

HI,
the result of the scan is inside the container and after running the scan it will be gone with container , how we can get the scan result back to the local system.

Writing analyzer result to '/home/ort/out/analyzer-result.yml'.

]# docker run   -v /ort/Node-Training:/project   ghcr.io/alliander-opensource/ort-container --info -c /project/ort/config.yml  analyze -i /project -o  out
14:10:33,280 |-INFO in ch.qos.logback.classic.LoggerContext[default] - This is logback-classic version 1.4.1
14:10:33,302 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Could NOT find resource [logback-test.xml]
14:10:33,312 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Found resource [logback.xml] at [jar:file:/opt/ort/lib/cli-DOCKER-SNAPSHOT.jar!/logback.xml]
14:10:33,313 |-WARN in ch.qos.logback.classic.util.DefaultJoranConfigurator@48284d0e - Resource [logback.xml] occurs multiple times on the classpath.
14:10:33,313 |-WARN in ch.qos.logback.classic.util.DefaultJoranConfigurator@48284d0e - Resource [logback.xml] occurs at [jar:file:/opt/ort/lib/helper-cli-DOCKER-SNAPSHOT.jar!/logback.xml]
14:10:33,313 |-WARN in ch.qos.logback.classic.util.DefaultJoranConfigurator@48284d0e - Resource [logback.xml] occurs at [jar:file:/opt/ort/lib/cli-DOCKER-SNAPSHOT.jar!/logback.xml]
14:10:33,323 |-INFO in ch.qos.logback.core.joran.spi.ConfigurationWatchList@557286ad - URL [jar:file:/opt/ort/lib/cli-DOCKER-SNAPSHOT.jar!/logback.xml] is not of type file
14:10:33,442 |-INFO in ch.qos.logback.core.model.processor.AppenderModelHandler - Processing appender named [STDOUT]
14:10:33,443 |-INFO in ch.qos.logback.core.model.processor.AppenderModelHandler - About to instantiate appender of type [ch.qos.logback.core.ConsoleAppender]
14:10:33,464 |-INFO in ch.qos.logback.core.model.processor.ImplicitModelHandler - Assuming default type [ch.qos.logback.classic.encoder.PatternLayoutEncoder] for [encoder] property
14:10:33,500 |-INFO in ch.qos.logback.classic.model.processor.RootLoggerModelHandler - Setting level of ROOT logger to WARN
14:10:33,506 |-INFO in ch.qos.logback.core.model.processor.AppenderRefModelHandler - Attaching appender named [STDOUT] to Logger[ROOT]
14:10:33,508 |-INFO in ch.qos.logback.classic.model.processor.LoggerModelHandler - Setting level of logger [org.apache.http.headers] to ERROR
14:10:33,508 |-INFO in ch.qos.logback.classic.model.processor.LoggerModelHandler - Setting level of logger [org.apache.http.wire] to ERROR
14:10:33,508 |-INFO in ch.qos.logback.classic.model.processor.LoggerModelHandler - Setting level of logger [org.eclipse.jgit.internal.storage.file.FileSnapshot] to ERROR
14:10:33,508 |-INFO in ch.qos.logback.classic.model.processor.LoggerModelHandler - Setting level of logger [org.ossreviewtoolkit.analyzer.managers.Yarn2] to INFO
14:10:33,508 |-INFO in ch.qos.logback.classic.model.processor.LoggerModelHandler - Setting level of logger [org.ossreviewtoolkit.clients.fossid.FossIdRestService] to INFO
14:10:33,508 |-INFO in ch.qos.logback.classic.model.processor.LoggerModelHandler - Setting level of logger [org.ossreviewtoolkit.reporter.reporters.fossid.FossIdReporter] to INFO
14:10:33,508 |-INFO in ch.qos.logback.classic.model.processor.LoggerModelHandler - Setting level of logger [org.ossreviewtoolkit.scanner.scanners.fossid.FossId] to INFO
14:10:33,509 |-INFO in ch.qos.logback.classic.model.processor.LoggerModelHandler - Setting level of logger [org.ossreviewtoolkit.scanner.scanners.fossid.FossIdConfig] to INFO
14:10:33,509 |-INFO in ch.qos.logback.core.model.processor.DefaultProcessor@b10a26d - End of configuration.
14:10:33,527 |-INFO in ch.qos.logback.classic.joran.JoranConfigurator@74075134 - Registering current configuration as safe fallback point

14:10:33.737 [main] INFO  org.ossreviewtoolkit.model.config.OrtConfiguration - Using ORT configuration file '/project/ort/config.yml'.
________ _____________________
\_____  \\______   \__    ___/ the OSS Review Toolkit, version DOCKER-SNAPSHOT.
 /   |   \|       _/ |    |
/    |    \    |   \ |    |    Running 'analyze' under Java 11.0.16.1 on Linux with
\_______  /____|_  / |____|    8 CPUs and a maximum of 5006 MiB of memory.
        \/       \/
Environment variables:
ORT_CONFIG_DIR = /home/ort/.ort/config
ORT_DATA_DIR = /home/ort/.ort
JAVA_HOME = /opt/java/openjdk
ANDROID_HOME = /opt/android-sdk

Looking for analyzer-specific configuration in the following files and directories:
        /home/ort/.ort/config/curations.yml (does not exist)
        /home/ort/.ort/config/curations (does not exist)
        /project/.ort.yml (does not exist)
        /home/ort/.ort/config/resolutions.yml (does not exist)
The following package managers are enabled:
        Bower, Bundler, Cargo, Carthage, CocoaPods, Composer, Conan, DotNet, GoDep, GoMod, Gradle, Maven, NPM, NuGet, PIP, PNPM, Pipenv, Poetry, Pub, SBT, SpdxDocumentFile, Stack, Unmanaged, Yarn, Yarn2
Analyzing project path:
        /project
14:10:34.380 [main] INFO  org.ossreviewtoolkit.analyzer.PackageManager - Not analyzing directory '/project/.git' as it is hard-coded to be ignored.
Found 1 Unmanaged definition file(s) at:
        .
Found 1 definition file(s) from 1 package manager(s) in total.
14:10:34.470 [main] INFO  org.ossreviewtoolkit.analyzer.Analyzer - Starting Unmanaged analysis.
14:10:34.483 [DefaultDispatcher-worker-1] INFO  org.ossreviewtoolkit.analyzer.PackageManager - Resolving Unmanaged dependencies for path '.'...
14:10:34.780 [DefaultDispatcher-worker-1] INFO  org.ossreviewtoolkit.utils.ort.OrtProxySelector - Proxy selector was successfully installed.
14:10:34.807 [DefaultDispatcher-worker-1] INFO  org.ossreviewtoolkit.utils.ort.OrtAuthenticator - Authenticator was successfully installed.
14:10:35.046 [DefaultDispatcher-worker-1] INFO  org.ossreviewtoolkit.analyzer.PackageManager - Resolving Unmanaged dependencies for path '.' took 548.796016ms.
14:10:35.047 [DefaultDispatcher-worker-1] INFO  org.ossreviewtoolkit.analyzer.Analyzer - Finished Unmanaged analysis.
14:10:35.074 [DefaultDispatcher-worker-3] INFO  org.ossreviewtoolkit.analyzer.AnalyzerResultBuilder - Getting package curations took 615.99us.
Found 1 project(s) and 0 package(s) in total (not counting excluded ones).
Applied 0 curation(s) from 1 provider(s).
Writing analyzer result to '/home/ort/out/analyzer-result.yml'.
14:10:36.072 [main] INFO  org.ossreviewtoolkit.cli.commands.AnalyzerCommand - Wrote ORT result to 'analyzer-result.yml' (0.00 MiB) in 923.840391ms.
Resolved issues: 0 errors, 0 warnings, 0 hints.
Unresolved issues: 0 errors, 0 warnings, 0 hints.

[nicorikken]

@roshvin We also have a GitHub Action that uses this container. In there we have an entrypoint that calls the analysis command: https://github.com/alliander-opensource/license-scan-action/blob/35e2a37c29dfefb684ad4918839ec7ff2fc321b2/entrypoint.sh#L67-L75
In this case the ort command is called from the working directory to which the project directory is mounted. The results are written to a specific directory using the -o flag.

In your case if you want to run it as a oneliner, I would change your current command:

docker run   -v /ort/Node-Training:/project   ghcr.io/alliander-opensource/ort-container --info -c /project/ort/config.yml  analyze -i /project -o  out

to:

docker run   -v /ort/Node-Training:/project   ghcr.io/alliander-opensource/ort-container --info -c /project/ort/config.yml  analyze -i /project -o  /project/out

Assuming that the out directory is present, otherwise that might cause an error.

As this container is a 1:1 build from the upstream repository, I suggest to get involved with the larger ORT community as well, at https://github.com/oss-review-toolkit/ort and ort-talk Slack.