Bug 1867321 (ansible-collection-ansible-netcommon) - Review Request: ansible-collection-ansible-netcommon - Ansible Network Collection for Common Code
Summary: Review Request: ansible-collection-ansible-netcommon - Ansible Network Collec...
Keywords:
Status: CLOSED NEXTRELEASE
Alias: ansible-collection-ansible-netcommon
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Andy Mender
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-08-08 17:47 UTC by Igor Raits
Modified: 2020-09-06 08:40 UTC (History)
2 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2020-09-06 08:40:06 UTC
Type: ---
Embargoed:
andymenderunix: fedora-review+


Attachments (Terms of Use)

Description Igor Raits 2020-08-08 17:47:03 UTC
Spec URL: https://ignatenkobrain.fedorapeople.org/for-review/ansible-collection-ansible-netcommon.spec
SRPM URL: https://ignatenkobrain.fedorapeople.org/for-review/ansible-collection-ansible-netcommon-1.1.2-1.fc33.src.rpm
Description:
Ansible Network Collection for Common Code.
Fedora Account System Username: ignatenkobrain

Comment 1 Andy Mender 2020-08-08 22:28:52 UTC
I'll try to review this, but unfortunately I have no experience with Ansible collection modules and the only other package for reference I could find was "ansible-collection-netbox-netbox": https://src.fedoraproject.org/rpms/ansible-collection-netbox-netbox/blob/master/f/ansible-collection-netbox-netbox.spec

Koji build: https://koji.fedoraproject.org/koji/taskinfo?taskID=48933017

> License:        GPLv3+

licensecheck reports extra licenses:
ansible.netcommon-1.1.2/plugins/module_utils/compat/ipaddress.py: Python Software Foundation License version 2
ansible.netcommon-1.1.2/plugins/module_utils/network/common/config.py: BSD 2-clause "Simplified" License
ansible.netcommon-1.1.2/plugins/module_utils/network/common/netconf.py: BSD 2-clause "Simplified" License
ansible.netcommon-1.1.2/plugins/module_utils/network/common/network.py: BSD 2-clause "Simplified" License
ansible.netcommon-1.1.2/plugins/module_utils/network/common/parsing.py: BSD 2-clause "Simplified" License
ansible.netcommon-1.1.2/plugins/module_utils/network/common/utils.py: BSD 2-clause "Simplified" License
ansible.netcommon-1.1.2/plugins/module_utils/network/restconf/restconf.py: BSD 2-clause "Simplified" License

These files are not inside the "modules" subdir so maybe they're not actually installed?

> BuildRequires:  ansible >= 2.9.10

For reference, ansible-collection-netbox-netbox lists the following BuildRequires:
> BuildRequires:  ansible
> BuildRequires:  python3-rpm-macros

Is the "python3-rpm-macros" package not needed by the netcommon Ansible module?

> %prep
> %autosetup -n ansible.netcommon-%{version}
> sed -i -e '/version:/s/null/%{version}/' galaxy.yml

I noticed that ansible-collection-netbox-netbox in addition removes the integration tests and does some sed cleanup magic:
> %prep
> %autosetup -n ansible_modules-%{version}
> sed -i -e '1{\@^#!.*@d}' plugins/modules/*.py
> rm -vr tests/integration

Log generated by rpmlint inside fedora-review:
> Rpmlint
> -------
> Checking: ansible-collection-ansible-netcommon-1.1.2-1.fc33.noarch.rpm
>           ansible-collection-ansible-netcommon-1.1.2-1.fc33.src.rpm
> ansible-collection-ansible-netcommon.noarch: E: version-control-internal-file /usr/share/ansible/collections/ansible_collections/ansible/netcommon/.gitignore
> ansible-collection-ansible-netcommon.noarch: W: hidden-file-or-dir /usr/share/ansible/collections/ansible_collections/ansible/netcommon/.yamllint

I've seen similar entries when running fedora-review on "ansible-collection-netbox-netbox":
> ansible-collection-netbox-netbox.noarch: W: hidden-file-or-dir /usr/share/ansible/collections/ansible_collections/netbox/netbox/.github
> ansible-collection-netbox-netbox.noarch: W: hidden-file-or-dir /usr/share/ansible/collections/ansible_collections/netbox/netbox/.github
> ansible-collection-netbox-netbox.noarch: E: version-control-internal-file /usr/share/ansible/collections/ansible_collections/netbox/netbox/.gitignore
> ansible-collection-netbox-netbox.noarch: W: hidden-file-or-dir /usr/share/ansible/collections/ansible_collections/netbox/netbox/.travis.yml

I somehow don't think Ansible uses these internally, but I might be wrong. If these are not actually a part of the package, they should be removed.

> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/cli_command.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/cli_config.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_banner.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_get.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_interface.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_l2_interface.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_l3_interface.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_linkagg.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_lldp.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_lldp_interface.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_logging.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_ping.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_put.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_static_route.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_system.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_user.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_vlan.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_vrf.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/netconf_config.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/netconf_get.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/netconf_rpc.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/restconf_config.py 644 /usr/bin/python 
> ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/restconf_get.py 644 /usr/bin/python

These lines don't show up when running fedora-review on "ansible-collection-netbox-netbox". The original sources of your package and the "ansible-connection-netbox-netbox" package contain the "#!/usr/bin/python" shebang. I think the sed line I pulled from "ansible-connection-netbox-netbox" actually gets rid of this shebang. 

> ansible-collection-ansible-netcommon.noarch: E: version-control-internal-file /usr/share/ansible/collections/ansible_collections/ansible/netcommon/tests/.gitignore

Again, a VCS file which probably shouldn't be there.

> ansible-collection-ansible-netcommon.src: W: unexpanded-macro URL %{ansible_collection_url}
> ansible-collection-ansible-netcommon.src: W: invalid-url URL %{ansible_collection_url}

This you can ignore. rpmlint is simply not aware of the macros.

Full review matrix:
Package Review
==============

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



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

Generic:
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
     Note: Using prebuilt packages
     Review: Tested locally and via Koji.
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[!]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "GPL (v3 or later)", "*No copyright*
     GPL (v3 or later)", "Python Software Foundation License version 2",
     "BSD 2-clause "Simplified" License". 132 files have unknown license.
     Detailed output of licensecheck in
     /home/amender/rpmbuild/SPECS/ansible-collection-ansible-
     netcommon/ansible-collection-ansible-netcommon/licensecheck.txt
     Review: temporarily set to "fail". See earlier comments.
[x]: Package contains no bundled libraries without FPC exception.
[x]: 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
[?]: 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.
[!]: Requires correct, justified where necessary.
     Review: temporarily set to "fail". See comments about python3-rpm-macros.
[x]: Spec file is legible and written in American English.
[-]: Package contains systemd file(s) if in need.
[x]: Package is not known to require an ExcludeArch tag.
     Review: it's a noarch package.
[-]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 20480 bytes in 1 files.
[x]: Package complies to the Packaging Guidelines
     Review: "pass", but see earlier comments.
[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

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

Generic:
[x]: Reviewer should test that the package builds in mock.
     Review: tested in mock and via Koji.
[-]: 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.
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[-]: 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.
     Review: this is a noarch package.
[?]: %check is present and all tests pass.
     Review: Some tests are provided. Should these be run?
[x]: Packages should try to preserve timestamps of original installed
     files.
[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]: Sources can be downloaded from URI in Source: tag
[x]: SourceX is a working URL.
[x]: Spec use %global instead of %define unless justified.

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

Generic:
[x]: Rpmlint is run on all installed packages.
     Note: No rpmlint messages.


Rpmlint
-------
Checking: ansible-collection-ansible-netcommon-1.1.2-1.fc33.noarch.rpm
          ansible-collection-ansible-netcommon-1.1.2-1.fc33.src.rpm
ansible-collection-ansible-netcommon.noarch: E: version-control-internal-file /usr/share/ansible/collections/ansible_collections/ansible/netcommon/.gitignore
ansible-collection-ansible-netcommon.noarch: W: hidden-file-or-dir /usr/share/ansible/collections/ansible_collections/ansible/netcommon/.yamllint
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/cli_command.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/cli_config.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_banner.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_get.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_interface.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_l2_interface.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_l3_interface.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_linkagg.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_lldp.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_lldp_interface.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_logging.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_ping.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_put.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_static_route.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_system.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_user.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_vlan.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/net_vrf.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/netconf_config.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/netconf_get.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/netconf_rpc.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/restconf_config.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: non-executable-script /usr/share/ansible/collections/ansible_collections/ansible/netcommon/plugins/modules/restconf_get.py 644 /usr/bin/python 
ansible-collection-ansible-netcommon.noarch: E: version-control-internal-file /usr/share/ansible/collections/ansible_collections/ansible/netcommon/tests/.gitignore
ansible-collection-ansible-netcommon.src: W: unexpanded-macro URL %{ansible_collection_url}
ansible-collection-ansible-netcommon.src: W: invalid-url URL %{ansible_collection_url}
2 packages and 0 specfiles checked; 25 errors, 3 warnings.




Rpmlint (installed packages)
----------------------------
(none): E: no installed packages by name ansible-collection-ansible-netcommon
0 packages and 0 specfiles checked; 0 errors, 0 warnings.



Source checksums
----------------
https://github.com/ansible-collections/ansible.netcommon/archive/1.1.2/ansible-collection-ansible-netcommon-1.1.2.tar.gz :
  CHECKSUM(SHA256) this package     : 84bf3fe6318dea1db10b381c37b5021c322ec973867edb72b40dcec718fe3a3b
  CHECKSUM(SHA256) upstream package : 84bf3fe6318dea1db10b381c37b5021c322ec973867edb72b40dcec718fe3a3b


Requires
--------
ansible-collection-ansible-netcommon (rpmlib, GLIBC filtered):
    (ansible >= 2.9.0 with ansible < 2.10.0)



Provides
--------
ansible-collection-ansible-netcommon:
    ansible-collection(ansible.netcommon)
    ansible-collection-ansible-netcommon

Comment 3 Igor Raits 2020-08-09 07:20:06 UTC
Hi Andy,

Thank you for review! For sure ansible-collections-netbox-netbox is my package and I am creator of all those packaging-related macros for Ansible :)

> licensecheck reports extra licenses:

I somehow did not notice this, I've fixed it in spec and also opened issue in upstream https://github.com/ansible-collections/ansible.netcommon/issues/116.

> Is the "python3-rpm-macros" package not needed by the netcommon Ansible module?

No, it was needed there only for %{python3_version} macro that is used in Requires.

> I noticed that ansible-collection-netbox-netbox in addition removes the integration tests and does some sed cleanup magic:

Yeah, probably we should do same, fixed.

> I somehow don't think Ansible uses these internally, but I might be wrong. If these are not actually a part of the package, they should be removed.

Fixed.

Comment 4 Andy Mender 2020-08-09 09:54:58 UTC
> Thank you for review! For sure ansible-collections-netbox-netbox is my package and I am creator of all those packaging-related macros for Ansible :)

Ah, wasn't aware of that, apologies!

> I somehow did not notice this, I've fixed it in spec and also opened issue in upstream https://github.com/ansible-collections/ansible.netcommon/issues/116.

Thanks for doing this. I double-checked the files in question and yes, licensecheck wasn't wrong. There is a little note about possible downstream re-licensing, though:
> # This code is part of Ansible, but is an independent component.
> # This particular file snippet, and this file snippet only, is BSD licensed.
> # Modules you write using this snippet, which is embedded dynamically by Ansible
> # still belong to the author of the module, and may assign their own license
> # to the complete work.

I re-ran fedora-review. The rpmlint log is clean now:
> Rpmlint
> -------
> Checking: ansible-collection-ansible-netcommon-1.1.2-1.fc33.noarch.rpm
>           ansible-collection-ansible-netcommon-1.1.2-1.fc33.src.rpm
> ansible-collection-ansible-netcommon.src: W: unexpanded-macro URL %{ansible_collection_url}
> ansible-collection-ansible-netcommon.src: W: invalid-url URL %{ansible_collection_url}
> 2 packages and 0 specfiles checked; 0 errors, 2 warnings.

Package approved!

Comment 5 Igor Raits 2020-08-09 10:54:39 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/ansible-collection-ansible-netcommon

Comment 6 Andy Mender 2020-09-06 08:40:06 UTC
Closing as package was approved for Fedora 33 already.


Note You need to log in before you can comment on or make changes to this bug.