Bug 1488093 - Review Request: python-krbcontext - A Kerberos context manager
Summary: Review Request: python-krbcontext - A Kerberos context manager
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Robert-André Mauchin 🐧
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-09-04 10:14 UTC by cqi
Modified: 2020-05-19 10:20 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-05-19 10:20:36 UTC
Type: ---
Embargoed:
zebob.m: fedora-review+


Attachments (Terms of Use)

Description cqi 2017-09-04 10:14:15 UTC
Spec URL: https://copr-be.cloud.fedoraproject.org/results/cqi/python-krbcontext/fedora-26-x86_64/00595699-python-krbcontext/python-krbcontext.spec
SRPM URL: https://copr-be.cloud.fedoraproject.org/results/cqi/python-krbcontext/fedora-26-x86_64/00595699-python-krbcontext/python-krbcontext-0.7-1.fc26.src.rpm
Description: krbcontext provides a Kerberos context where you can put code inside which requires a valid ticket in credential cache. Document https://krbcontext.github.io/usage.html gives detailed information of how to use it.
Fedora Account System Username: cqi

Comment 1 Robert-André Mauchin 🐧 2017-09-04 18:06:41 UTC
Hello,

 - Source0 is returning 404. In order to fix it, change %{name} to %{src_name}:

Source0: https://files.pythonhosted.org/packages/source/k/%{src_name}/%{src_name}-%{version}.tar.gz

 - The Group: tag is not used in Fedora. See https://fedoraproject.org/wiki/Packaging:Guidelines#Tags_and_Sections

 - Similarly, no %clean section is needed

 - %defattr(-,root,root) is not needed either in %files sections

 - You should probably use %python_version macro for your tests:

%check
PYTHONPATH=. py.test-%{python2_version} test/
PYTHONPATH=. py.test-%{python3_version} test/

 - You need to add python provides in each %package section:

   * for the Python2 package:

%package -n python2-%{src_name}
Summary: A Kerberos context manager

BuildRequires: python-devel
BuildRequires: python-setuptools
BuildRequires: python-gssapi
# For running test
BuildRequires: python2-mock
BuildRequires: python-flake8
BuildRequires: python-pytest-cov
BuildRequires: python2-pytest

Requires: python-gssapi
%{?python_provide:%python_provide python2-%{src_name}}


   * for the Python3 package:

%package -n python3-%{src_name}
Summary: A Kerberos context manager

BuildRequires: python3-setuptools
BuildRequires: python3-devel
BuildRequires: python3-gssapi
# For running test
BuildRequires: python3-flake8
BuildRequires: python3-mock
BuildRequires: python3-pytest
BuildRequires: python3-pytest-cov

Requires: python3-gssapi
%{?python_provide:%python_provide python%{python3_pkgversion}-%{src_name}}

  - You mustn't use %define, but %global instead:

%global src_name krbcontext

 - You musn't add LICENSE into %doc but into %license:

%files -n python2-%{src_name}
%license LICENSE
%doc README.rst CHANGELOG.rst docs/

  and:

%files -n python3-%{src_name}
%license LICENSE
%doc README.rst CHANGELOG.rst docs/



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

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


Issues:
=======
- 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.
  Note: License file LICENSE is not marked as %license
  See:
  http://fedoraproject.org/wiki/Packaging/LicensingGuidelines#License_Text


===== 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: "GPL (v3 or later)", "Unknown or generated". 26 files have
     unknown license. Detailed output of licensecheck in
     /home/bob/packaging/review/python-krbcontext/review-python-
     krbcontext/licensecheck.txt
[!]: License file installed when any subpackage combination is installed.
[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
[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.
[-]: Package contains systemd file(s) if in need.
[x]: Package is not known to require an ExcludeArch tag.
[-]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 143360 bytes in 18 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]: 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]: All build dependencies are listed in BuildRequires, except for any
     that are listed in the exceptions section of Packaging Guidelines.
[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 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.
[!]: Package meets the Packaging Guidelines::Python
     → You need to add provides
[x]: Package contains BR: python2-devel or python3-devel
[x]: Binary eggs must be removed in %prep

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

Generic:
[-]: 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).
[x]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in
     python2-krbcontext , python3-krbcontext
[?]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: 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.
[x]: %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 src_name krbcontext
[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]: Sources can be downloaded from URI in Source: tag
[x]: SourceX is a working URL.

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

Generic:
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python2-krbcontext-0.7-1.fc28.noarch.rpm
          python3-krbcontext-0.7-1.fc28.noarch.rpm
          python-krbcontext-0.7-1.fc28.src.rpm
python2-krbcontext.noarch: W: spelling-error %description -l en_US keytab -> key tab, key-tab, Kenyatta
python3-krbcontext.noarch: W: spelling-error %description -l en_US keytab -> key tab, key-tab, Kenyatta
python-krbcontext.src: W: spelling-error %description -l en_US keytab -> key tab, key-tab, Kenyatta
3 packages and 0 specfiles checked; 0 errors, 3 warnings.

Comment 2 cqi 2017-09-05 06:38:00 UTC
Hi, please review again. This time, I created a new dedicated project in Fedora Copr for package review.

SPEC URL: https://copr-be.cloud.fedoraproject.org/results/cqi/krbcontext-package-review/fedora-26-x86_64/00598427-python-krbcontext/python-krbcontext.spec
SRPM URL: https://copr-be.cloud.fedoraproject.org/results/cqi/krbcontext-package-review/fedora-26-x86_64/00598427-python-krbcontext/python-krbcontext-0.7-1.fc26.src.rpm

Fixed issues you pointed out above.

Regarding the work keytab, I would like to keep it as that is a term in Kerberos and it is also mentioned in various Kerberos documentation.

Thank you very much for your review.

Comment 3 Robert-André Mauchin 🐧 2017-09-05 07:13:00 UTC
Don't worry about rpmlint spelling errors, they're not relevant in most cases, it just use a standard dictionary and a lot of technical terms aren't included in it.

The package is good, package accepted.

Comment 4 cqi 2017-09-05 08:06:09 UTC
Thank you very much.

I changed package name in summary as I was not aware of this name in summary should match the repo name which I'll request in next step.

Comment 5 Gwyn Ciesla 2017-09-05 12:34:14 UTC
(fedrepo-req-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-krbcontext. You may create the branch "f27" using git in about 10 minutes.


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