Bug: Sc Install Instructions Show Errors In The

by ADMIN 48 views

Bug: sc install instructions show errors in the

Problem/Opportunity

The first installation of sc isn't clean and comes up with unknown errors, that I've got no clue how to resolve or understand. This is a major issue as it prevents users from using the sc tool effectively. To resolve this issue, we need to upgrade our testing suites to cover the following cases.

Incorrect python version

When the user installs sc, they may encounter an error due to an incorrect Python version. This can be resolved by ensuring that the user meets the following requirements:

  • Install Python 3.10+
Error: [python not found or version in compatible]
Please ensure you meet the following requirements:-
- Install Python 3.10+

No Docker binary

Another common issue is when the user doesn't have the Docker binary installed. This can be resolved by ensuring that the user meets the following requirements:

  • Install the docker engine instructions can be found here
  • Access to the docker engine, could require privileged permissions, on linux it requires the user to be part of the docker group.
Erorr: [docker binary not found]
Please ensure you meet the following requirements:-
- Install the docker engine instructions can be found [here](https://docs.docker.com/engine/install/)
- Access to the docker engine, could require privileged permissions, on linux it requires the user to be part of the docker group.

No Configuration

If the user doesn't have the correct configuration, they may encounter an error. This can be resolved by ensuring that the user meets the following requirements:

Error: No Login configuration and can't find login details in your ~/.netrc
Please ensure you meet the following requirements:-
- ~/.netrc - must contain login information for the artfactory
- Detailed information is found here [https://github.com/rdkcentral/sc-docker/blob/main/docs/pages/login.md](https://github.com/rdkcentral/sc-docker/blob/main/docs/pages/login.md)

Not Logged in

If the user is not logged in, they may encounter an error. This can be resolved by ensuring that the user meets the following requirements:

  • Run the login command internally to ensure it works.

Incorrect configuration

If the user has an incorrect configuration, they may encounter an error. This can be resolved by ensuring that the user meets the following requirements:

  • Run a test api, and report any errors back to the user... With english resolution infomration
Error: Incorrect configuration and can't find login details in your ~/.netrc
I've tried to use your configuration but I can't login

Please ensure you meet the following requirements:-
- ~/.netrc - must contain login information for the artfactory 
More information is found here [https://github.com/rdkcentral/sc-docker/blob/main/docs/pages/login.md](https://github.com/rdkcentral/sc-docker/blob/main/docs/pages/login.md)

Steps to reproduce

First issue.

I'm running latest bash on my Mac, and there are some packages missing if I follow the installation instructions.

pip install git+https://github.com/rdkcentral/sc.git@main
pip install git+https://github.com/rdkcentral/sc-docker.git@main

results in

sc docker
Traceback (most recent call last):
  File "/Users/gew04/pyenv/bin/sc", line 5, in <module>
    from sc.cli import entry_point
  File "/Users/gew04/pyenv/lib/python3.13/site-packages/sc/cli.py", line 19, in <module>
    import pkg_resources
ModuleNotFoundError: No module named 'pkg_resources'

I've fixed this with installing pkg_reousrces, I run a venv for my system I'm not sure why this package isn't there, this must be added to your instructions. I also tried with a multipass linux and this results in the same thing, so missing from your instructions.

pip install setuptools

my pyenv

certifi==2025.1.31
charset-normalizer==3.4.1
click==8.1.8
docker==7.1.0
idna==3.10
PyYAML==6.0.2
requests==2.31.0
sc @ git+https://github.com/rdkcentral/sc.git@b0fd457187045c697618178b777838b26fdbd117
sc-docker @ git+https://github.com/rdkcentral/sc-docker.git@8db41206ab0b47d99716609127d03229b1853ac4
setuptools==76.0.0
urllib3==2.3.0

2nd Issue (no binary check for docker)

I've not installed docker and I don't get any notification that it's not working, so we should provide better error reporting here.

 sc docker
Error while fetching server API version: ('Connection aborted.', FileNotFoundError(2, 'No such file or directory'))
Usage: sc [OPTIONS] COMMAND [ARGS]...
Try 'sc --help' for help.

Error: No such command 'docker'.

3rd Issue ~/.netrc not working

I've setup my ~/.netrc but still no joy and no information as to why it would not work, and there are no messages to state you did or did not find the information for the login from the .netrc and tried to validate with a default function or something.

4th Issue

  • Docker not found comment even when docker is installed
sc docker

Error while fetching server API version: ('Connection aborted.', PermissionError(13, 'Permission denied'))

Usage: sc [OPTIONS] COMMAND [ARGS]...

Try 'sc --help' for help.

Error: No such command 'docker'.

Error: No such command 'docker'. - is being displayed but docker is present.

which docker

/usr/bin/docker

Expected Behavior

it works out of the box.

Ideally also installs it's own environment, downloads all its own requirements, and just works.

Actual Behavior

  • not working with the instructions and no clues as to what's wrong.

Notes (Optional)

No response

Conclusion

The sc install instructions show errors in the following cases:

  • Incorrect python version
  • No Docker binary
  • No Configuration
  • Not Logged in
  • Incorrect configuration

To resolve these issues, we need to upgrade our testing suites to cover the following cases. We also need to provide better error reporting and ensure that the user meets the following requirements:

  • Install Python 3.10+
  • Install the docker engine instructions can be found here
  • Access to the docker engine, could require privileged permissions, on linux it requires the user to be part of the docker group.
  • ~/.netrc - must contain login information for the artfactory
  • Detailed information is found here https://github.com/rdkcentral/sc-docker/blob/main/docs/pages/login.md

By resolving these issues, we can ensure that the sc tool works out of the box and provides a better user experience.
Bug: sc install instructions show errors in the

Q&A

Q: What are the common issues that users encounter when installing sc?

A: The common issues that users encounter when installing sc are:

  • Incorrect python version
  • No Docker binary
  • No Configuration
  • Not Logged in
  • Incorrect configuration

Q: What is the expected behavior of the sc tool?

A: The expected behavior of the sc tool is that it works out of the box and installs its own environment, downloads all its own requirements, and just works.

Q: What is the actual behavior of the sc tool?

A: The actual behavior of the sc tool is that it does not work with the instructions and does not provide any clues as to what is wrong.

Q: How can users resolve the issue of incorrect python version?

A: Users can resolve the issue of incorrect python version by ensuring that they meet the following requirements:

  • Install Python 3.10+

Q: How can users resolve the issue of no Docker binary?

A: Users can resolve the issue of no Docker binary by ensuring that they meet the following requirements:

  • Install the docker engine instructions can be found here
  • Access to the docker engine, could require privileged permissions, on linux it requires the user to be part of the docker group.

Q: How can users resolve the issue of no configuration?

A: Users can resolve the issue of no configuration by ensuring that they meet the following requirements:

Q: How can users resolve the issue of not being logged in?

A: Users can resolve the issue of not being logged in by running the login command internally to ensure it works.

Q: How can users resolve the issue of incorrect configuration?

A: Users can resolve the issue of incorrect configuration by running a test api, and reporting any errors back to the user... With english resolution infomration.

Q: What are the steps to reproduce the issue?

A: The steps to reproduce the issue are:

  1. Run the following commands:
pip install git+https://github.com/rdkcentral/sc.git@main
pip install git+https://github.com/rdkcentral/sc-docker.git@main
  1. Run the following command:
sc docker
  1. Observe the error message.

Q: What is the expected output of the sc tool?

A: The expected output of the sc tool is that it works out of the box and provides a better user experience.

Q: What is the actual output of the sc tool?

A: The actual output of the sc tool is that it does not work with the instructions and does not provide any clues as to what is wrong.

Q: How can users troubleshoot the issue?

A: Users can troubleshoot the issue by checking the following:

  • Python version
  • Docker binary
  • Configuration
  • Login status
  • Configuration

By following these steps, users can troubleshoot the issue and resolve it.

Conclusion

The sc install instructions show errors in the following cases:

  • Incorrect python version
  • No Docker binary
  • No Configuration
  • Not Logged in
  • Incorrect configuration

To resolve these issues, users can follow the steps outlined above. By resolving these issues, users can ensure that the sc tool works out of the box and provides a better user experience.