Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.
RDO tickets are now tracked in Jira https://issues.redhat.com/projects/RDO/issues/

Bug 1839759

Summary: Package Review: python-ibmcclient
Product: [Community] RDO Reporter: jojo <qianbiao.ng>
Component: distributionAssignee: Yatin Karel <ykarel>
Status: CLOSED CURRENTRELEASE QA Contact: Shai Revivo <srevivo>
Severity: high Docs Contact:
Priority: high    
Version: trunkCC: jpena, markmc, srevivo, ykarel
Target Milestone: Milestone1Flags: ykarel: rdo-review+
Target Release: trunk   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2020-10-28 11:37:58 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1842401    

Description jojo 2020-05-25 13:21:32 UTC
python-ibmcclient[1] is a third-party client lib for ironic ibmc hardware.

This is the first time we submit it for review.

[1] https://github.com/IamFive/python-ibmcclient

Comment 1 Javier Peña 2020-05-25 16:35:01 UTC
Initial licensecheck output:

$ licensecheck -r .
./.travis.yml: *No copyright* UNKNOWN
./CHANGELOG.md: *No copyright* UNKNOWN
./LICENSE.txt: *No copyright* UNKNOWN
./MANIFEST.in: *No copyright* UNKNOWN
./README.md: *No copyright* UNKNOWN
./coverage.sh: *No copyright* UNKNOWN
./requirements.txt: *No copyright* UNKNOWN
./setup.cfg: *No copyright* GENERATED FILE
./setup.py: *No copyright* Apache License
./test-requirements.txt: *No copyright* UNKNOWN
./tox.ini: *No copyright* UNKNOWN
./ibmc_client/__init__.py: Apache License (v2.0)
./ibmc_client/connector.py: Apache License (v2.0)
./ibmc_client/constants.py: Apache License (v2.0)
./ibmc_client/exceptions.py: Apache License (v2.0)
./ibmc_client/raid_config_schema.json: *No copyright* GENERATED FILE
./ibmc_client/raid_utils.py: Apache License (v2.0)
./ibmc_client/utils.py: Apache License (v2.0)
./ibmc_client/api/__init__.py: Apache License (v2.0)
./ibmc_client/resources/__init__.py: Apache License (v2.0)
./tests/unittests/__init__.py: *No copyright* UNKNOWN
./tests/unittests/test_apply_raid_config_cases.py: Apache License (v2.0)
./tests/unittests/test_chassis.py: *No copyright* UNKNOWN
./tests/unittests/test_connect.py: *No copyright* UNKNOWN
./tests/unittests/test_drive.py: *No copyright* UNKNOWN
./tests/unittests/test_storage.py: *No copyright* UNKNOWN
./tests/unittests/test_system.py: *No copyright* UNKNOWN
./tests/unittests/test_task.py: *No copyright* UNKNOWN
./tests/unittests/test_volume.py: *No copyright* UNKNOWN
./ibmc_client/api/chassis/__init__.py: Apache License (v2.0)
./ibmc_client/api/chassis/drive.py: Apache License (v2.0)
./ibmc_client/api/system/__init__.py: Apache License (v2.0)
./ibmc_client/api/system/bios.py: Apache License (v2.0)
./ibmc_client/api/system/storage.py: Apache License (v2.0)
./ibmc_client/api/system/volume.py: Apache License (v2.0)
./ibmc_client/api/task/task.py: Apache License (v2.0)
./ibmc_client/resources/chassis/__init__.py: Apache License (v2.0)
./ibmc_client/resources/chassis/drive.py: Apache License (v2.0)
./ibmc_client/resources/system/__init__.py: Apache License (v2.0)
./ibmc_client/resources/system/bios.py: Apache License (v2.0)
./ibmc_client/resources/system/boot_source_override.py: Apache License (v2.0)
./ibmc_client/resources/system/storage.py: Apache License (v2.0)
./ibmc_client/resources/task/__init__.py: Apache License (v2.0)
./tests/unittests/data/401.json: *No copyright* UNKNOWN
./tests/unittests/data/bios.json: *No copyright* UNKNOWN
./tests/unittests/data/create-volume-failed-400-response.json: *No copyright* UNKNOWN
./tests/unittests/data/create-volume-task-complete-response.json: *No copyright* UNKNOWN
./tests/unittests/data/create-volume-task-exception-response.json: *No copyright* UNKNOWN
./tests/unittests/data/create-volume-task-init-response.json: *No copyright* UNKNOWN
./tests/unittests/data/delete-volume-task-finished-response.json: *No copyright* UNKNOWN
./tests/unittests/data/delete-volume-task-response.json: *No copyright* UNKNOWN
./tests/unittests/data/get-chassis-response.json: *No copyright* UNKNOWN
./tests/unittests/data/get-complete-task-response.json: *No copyright* UNKNOWN
./tests/unittests/data/get-drive-0.json: *No copyright* UNKNOWN
./tests/unittests/data/get-drive-1.json: *No copyright* UNKNOWN
./tests/unittests/data/get-drive-2.json: *No copyright* UNKNOWN
./tests/unittests/data/get-drive-3.json: *No copyright* UNKNOWN
./tests/unittests/data/get-drive-4.json: *No copyright* UNKNOWN
./tests/unittests/data/get-drive-40.json: *No copyright* UNKNOWN
./tests/unittests/data/get-drive-41.json: *No copyright* UNKNOWN
./tests/unittests/data/get-drive-5.json: *No copyright* UNKNOWN
./tests/unittests/data/get-drive-6.json: *No copyright* UNKNOWN
./tests/unittests/data/get-drive-7.json: *No copyright* UNKNOWN
./tests/unittests/data/get-drive-fm-good-response.json: *No copyright* UNKNOWN
./tests/unittests/data/get-drive-fm-jbod-response.json: *No copyright* UNKNOWN
./tests/unittests/data/get-drive-fm-spare-response.json: *No copyright* UNKNOWN
./tests/unittests/data/get-initial-task-response.json: *No copyright* UNKNOWN
./tests/unittests/data/get-raid-storage-0.json: *No copyright* UNKNOWN
./tests/unittests/data/get-raid-storage-collection.json: *No copyright* UNKNOWN
./tests/unittests/data/get-volume-0.json: *No copyright* UNKNOWN
./tests/unittests/data/get-volume-1.json: *No copyright* UNKNOWN
./tests/unittests/data/get-volume-collection.json: *No copyright* UNKNOWN
./tests/unittests/data/manager-collection.json: *No copyright* UNKNOWN
./tests/unittests/data/manager.json: *No copyright* UNKNOWN
./tests/unittests/data/quick-init-volume-response.json: *No copyright* UNKNOWN
./tests/unittests/data/redfish.json: *No copyright* UNKNOWN
./tests/unittests/data/reset-system.json: *No copyright* UNKNOWN
./tests/unittests/data/restore-raid-storage-response.json: *No copyright* UNKNOWN
./tests/unittests/data/restore-storage-response.json: *No copyright* UNKNOWN
./tests/unittests/data/set-volume-bootable-response.json: *No copyright* UNKNOWN
./tests/unittests/data/system-v3.json: *No copyright* UNKNOWN
./tests/unittests/data/system-v5.json: *No copyright* UNKNOWN

The repo is licensed using the Apache 2.0 license, however the LICENSE.txt file does not contain correct information. Could this be fixed while we move on with the packaging process?

The next step, according to [1], will be to create a change to add the package to rdoinfo (see step 2)

[1] - https://www.rdoproject.org/documentation/add-packages/

Comment 2 jojo 2020-05-25 16:52:36 UTC
sure, I have updated license.txt.

Comment 3 Yatin Karel 2020-06-01 08:41:45 UTC
Fedora review output, there are following issues detected but those are accepted:-
- %check is absent, as tests directory missing in sources, maintainer wants to fix upstream and then add
- %changelog, %Source0, %define are handled by tool DLRN


Package Review
==============

Legend:
[x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated
[ ] = Manual review needed



===== MUST items =====

Generic:
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[x]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "*No copyright* Apache License (v2.0)",
     "*No copyright* Apache License", "Apache License (v2.0)". 13 files
     have unknown license. Detailed output of licensecheck in /tmp/python-
     ibmcclient/licensecheck.txt
[x]: Package contains no bundled libraries without FPC exception.
[!]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[-]: Package contains desktop file if it is a GUI application.
[-]: Development files must be in a -devel package
[x]: Package uses nothing in %doc for runtime.
[x]: Package consistently uses macros (instead of hard-coded directory
     names).
[x]: Package is named according to the Package Naming Guidelines.
[x]: Package does not generate any conflict.
[x]: Package obeys FHS, except libexecdir and /usr/target.
[-]: If the package is a rename of another package, proper Obsoletes and
     Provides are present.
[x]: Requires correct, justified where necessary.
[x]: Spec file is legible and written in American English.
[x]: Package contains systemd file(s) if in need.
[x]: Package is not known to require an ExcludeArch tag.
[x]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 10240 bytes in 2 files.
[x]: Package complies to the Packaging Guidelines
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
[x]: Package installs properly.
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).
[x]: If (and only if) the source package includes the text of the
     license(s) in its own file, then that file, containing the text of the
     license(s) for the package is included in %license.
[x]: Package requires other packages for directories it uses.
[x]: Package must own all directories that it creates.
[x]: Package does not own files or directories owned by other packages.
[x]: Package uses either %{buildroot} or $RPM_BUILD_ROOT
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[x]: Macros in Summary, %description expandable at SRPM build time.
[x]: Dist tag is present.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Package must not depend on deprecated() packages.
[x]: Package use %makeinstall only when make install DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: Package does not use a name that already exists.
[x]: Package is not relocatable.
[x]: Sources used to build the package match the upstream source, as
     provided in the spec URL.
[x]: Spec file name must match the spec package %{name}, in the format
     %{name}.spec.
[x]: File names are valid UTF-8.
[x]: Packages must not store files under /srv, /opt or /usr/local

Python:
[x]: Python eggs must not download any dependencies during the build
     process.
[x]: A package which is used by another package via an egg interface should
     provide egg info.
[x]: Package meets the Packaging Guidelines::Python
[x]: Package contains BR: python2-devel or python3-devel
[x]: Packages MUST NOT have dependencies (either build-time or runtime) on
     packages named with the unversioned python- prefix unless no properly
     versioned package exists. Dependencies on Python packages instead MUST
     use names beginning with python2- or python3- as appropriate.
[x]: Python packages must not contain %{pythonX_site(lib|arch)}/* in %files
[x]: Binary eggs must be removed in %prep

===== SHOULD items =====

Generic:
[x]: If the source package does not include license text(s) as a separate
     file from upstream, the packager SHOULD query upstream to include it.
[x]: Final provides and requires are sane (see attachments).
[?]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[!]: SourceX tarball generation or download is documented.
     Note: Package contains tarball without URL, check comments
[x]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[!]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[!]: Spec use %global instead of %define unless justified.
     Note: %define requiring justification: %define upstream_version 0.2.4
[x]: Reviewer should test that the package builds in mock.
[x]: Buildroot is not present
[x]: Package has no %clean section with rm -rf %{buildroot} (or
     $RPM_BUILD_ROOT)
[x]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: SourceX is a working URL.

===== EXTRA items =====

Generic:
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).


Rpmlint
-------
Checking: python3-ibmcclient-0.2.4-0.20200529111558.45ebd10.el8.noarch.rpm
          python-ibmcclient-0.2.4-0.20200529111558.45ebd10.el8.src.rpm
python3-ibmcclient.noarch: W: spelling-error Summary(en_US) iBMC -> IBM
python3-ibmcclient.noarch: W: spelling-error %description -l en_US iBMC -> IBM
python3-ibmcclient.noarch: W: spelling-error %description -l en_US ibmc -> IBM
python3-ibmcclient.noarch: E: no-changelogname-tag
python-ibmcclient.src: W: spelling-error Summary(en_US) iBMC -> IBM
python-ibmcclient.src: W: spelling-error %description -l en_US iBMC -> IBM
python-ibmcclient.src: W: spelling-error %description -l en_US ibmc -> IBM
python-ibmcclient.src: E: no-changelogname-tag
python-ibmcclient.src:66: W: macro-in-comment %check
python-ibmcclient.src:67: W: macro-in-comment %{__python3}
python-ibmcclient.src:74: W: macro-in-comment %exclude
python-ibmcclient.src:74: W: macro-in-comment %{python3_sitelib}
python-ibmcclient.src: E: specfile-error warning: Macro expanded in comment on line 74: %{python3_sitelib}/tests
2 packages and 0 specfiles checked; 3 errors, 14 warnings.




Rpmlint (installed packages)
----------------------------
python3-ibmcclient.noarch: E: no-changelogname-tag
python3-ibmcclient.noarch: W: invalid-url URL: https://github.com/IamFive/python-ibmcclient <urlopen error [Errno -2] Name or service not known>
1 packages and 0 specfiles checked; 1 errors, 3 warnings.



Requires
--------
python3-ibmcclient (rpmlib, GLIBC filtered):
    python(abi)
    python3-requests
    python3-six



Provides
--------
python3-ibmcclient:
    python3-ibmcclient
    python3.6dist(python-ibmcclient)
    python3dist(python-ibmcclient)


Package is Approved.

Comment 4 Yatin Karel 2020-10-28 11:37:58 UTC
Package available in RDO trunk/CloudSIG victoria repos.