Document how to run a basic scan/report workflow in CI

[deveaud-m]

Create a sample automated scan workflow using Fossology container as a service.

Document how to use the automated workflow in a CI pipeline.

[As-ajay06]

Hi, My name is Ajay sahani, i would like to work on this.

[deveaud-m]

@ajaySahani7945 thanks for proposing your help! I'll assign you the issue.

Do you know how to start or do you need some help?

[As-ajay06]

@deveaud-m Thanks, for assigning me this. And of,course Sir, i would like to know how do i start.

[deveaud-m]

Here would be the way I would proceed:

• create a test python project
• add fossology-python as dependency
• use a test file with source of an Open Source component, e.g. https://github.com/fossology/fossology-python/blob/main/tests/files/base-files_11.tar.xz
• pull the latest stable Fossology image as explained here: https://github.com/fossology/fossology#docker
• use the cli to perform following steps:
  • upload the source file to the local Fossology instance
  • start default scan jobs as documented in the docs
  • retrieve the scan report
• reproduce the same steps as a github action inside your project

Let me know, if you're having problems performing those steps

PS: call me Marion, I am a woman ;)

[As-ajay06]

Hi, Marion i cannot be able to pull image using command docker run -p 8081:80 fossology/fossology The output says docker permission denied (and more). What should i do? Please advise me with this problem. Thank you.

On Fri, Dec 8, 2023 at 5:06 PM Marion Deveaud @.***> wrote:

Here would be the way I would proceed:

• create a test python project
• add fossology-python as dependency
• use a test file with source of an Open Source component, e.g. https://github.com/fossology/fossology-python/blob/main/tests/files/base-files_11.tar.xz
• pull the latest stable Fossology image as explained here: https://github.com/fossology/fossology#docker
• use the cli to perform following steps:
  • upload the source file to the local Fossology instance
  • start default scan jobs as documented in the docs
  • retrieve the scan report
• reproduce the same steps as a github action inside your project

Let me know, if you're having problems performing those steps

PS: call me Marion, I am a woman ;)

— Reply to this email directly, view it on GitHub https://github.com/fossology/fossology-python/issues/73#issuecomment-1847030567, or unsubscribe https://github.com/notifications/unsubscribe-auth/BCWJIRJL6YDYRXREJHD2YMDYIL3VBAVCNFSM5BHH26OKU5DIOJSWCZC7NNSXTN2JONZXKZKDN5WW2ZLOOQ5TCOBUG4YDGMBVGY3Q . You are receiving this because you were mentioned.Message ID: @.***>

[deveaud-m]

@ajaySahani7945 docker pull fossology/fossology should work out of the box.

Which machine are you using?

Could you share the output of the command above?

(Please make use of proper markdown formatting when writing comments)

[As-ajay06]

I am using LinuxOS ( LinuxMint)

I have shared the photo of the output Share some suggestion

Thanks ## Marion

[deveaud-m]

The error says you're not allowed to pull the docker image. It seems your distribution installs the docker engine as root without giving normal users permissions to run containers. Have a look at the docker installation and search for potential resolutions in the distro's documentation.

Please do not post pictures in the issue tracker, copy&pasting the error message as code snippet would have been sufficient to understand the problem.

It seems you lack experience and knowledge to resolve this issue, maybe you should visit some computer science class or online course before trying to address a random issue in a random Open Source project.

[As-ajay06]

Ok, I'll check it out.

On Tue, Dec 19, 2023, 1:59 PM Marion Deveaud @.***> wrote:

The error says you're not allowed to pull the docker image. It seems your distribution installs the docker engine as root without giving normal users permissions to run containers. Have a look at the docker installation and search for potential resolutions in the distro's documentation.

Please do not post pictures in the issue tracker, copy&pasting the error message as code snippet would have been sufficient to understand the problem.

It seems you lack experience and knowledge to resolve this issue, maybe you should visit some computer science class or online course before trying to address a random issue in a random Open Source project.

— Reply to this email directly, view it on GitHub https://github.com/fossology/fossology-python/issues/73#issuecomment-1862323203, or unsubscribe https://github.com/notifications/unsubscribe-auth/BCWJIRLO3LUAVHHHLQJAAW3YKFF6XAVCNFSM5BHH26OKU5DIOJSWCZC7NNSXTN2JONZXKZKDN5WW2ZLOOQ5TCOBWGIZTEMZSGAZQ . You are receiving this because you were mentioned.Message ID: @.***>

[deveaud-m]

No resonance on this issue until now, closing.