Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance Docker support and add Windows executable for FossLight Scanner #123

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

soonhong99
Copy link
Contributor

@soonhong99 soonhong99 commented Sep 20, 2024

Description

This PR introduces two main improvements to the FossLight Scanner:

  1. Docker Support Enhancement:

    • Updated the Dockerfile to properly handle the -p and -o options without throwing errors.
    • These changes allow users to specify analysis and output paths more flexibly when running the Docker container.
  2. Windows Executable Creation:

    • Implemented fosslight_wrapper.py, a Python script that simplifies the process of using FossLight Scanner with Docker on Windows.
    • Added a GitHub Actions workflow that automatically creates a Windows executable (.exe) of fosslight_wrapper.py using PyInstaller when a new release is published.
    • This executable eliminates the need for manual Docker volume mounting, making it easier for Windows users to specify analysis and output paths.

These improvements aim to enhance user experience, particularly for Windows users, and make the FossLight Scanner more accessible and easier to use across different environments.

Testing Process

  1. Docker functionality:

    • Build the Docker image using the updated Dockerfile.
    • Run the container with various combinations of -p and -o options, ensuring no errors occur.
    • Verify that the analysis is performed correctly and output is saved in the specified locations.
  2. Windows executable:

    • Use the GitHub Actions workflow to create the Windows executable.
    • Run the executable on a Windows machine, providing various inputs for analysis paths and output locations.
    • Confirm that the executable correctly interfaces with the Docker container, performing the analysis and saving results as expected.
  3. Cross-platform testing:

    • Test the Docker image on both Linux and Windows environments to ensure consistent behavior.
    • Verify that the Windows executable and direct Docker usage produce identical results for the same inputs.

Type of change

Please insert 'x' one of the type of change.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation update
  • Refactoring, Maintenance
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

…ecutable for easier volume mounting

* refactor: Update Dockerfile to handle -p and -o options without errors
* feat: Implement fosslight_wrapper.py to simplify Docker volume mounting process
* ci: Add GitHub Actions workflow to create Windows executable using PyInstaller on release

Signed-off-by: soonhong99 <67502252+soonhong99@users.noreply.github.com>
@soonhong99
Copy link
Contributor Author

soonhong99 commented Sep 20, 2024

#122 docker automated release에 이은 PR입니다.

Signed-off-by: soonhong99 <67502252+soonhong99@users.noreply.github.com>
Signed-off-by: soonhong99 <67502252+soonhong99@users.noreply.github.com>
Copy link

@ParkSangsin ParkSangsin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

고생하셨습니다!

Copy link

@persi0815 persi0815 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@soimkim soimkim added the chore [PR/Issue] Refactoring, maintenance the code label Sep 28, 2024
Signed-off-by: soonhong99 <67502252+soonhong99@users.noreply.github.com>
@soimkim soimkim marked this pull request as draft October 3, 2024 12:00
@soimkim
Copy link
Contributor

soimkim commented Oct 3, 2024

리뷰 요청하실 때, Ready for review 클릭해주십시오.
(현재는 conflict 발생하는 것으로 보여 리뷰 요청 준비가 되지 않은 것으로 보입니다.)

@soonhong99 soonhong99 marked this pull request as ready for review October 4, 2024 02:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore [PR/Issue] Refactoring, maintenance the code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants