Bug 1179484 - Review Request: python-cram - Simple testing framework for command line applications
Summary: Review Request: python-cram - Simple testing framework for command line appli...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Zbigniew Jędrzejewski-Szmek
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2015-01-06 21:22 UTC by Ken Dreyer
Modified: 2016-01-08 03:28 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-01-07 19:28:17 UTC
Type: ---
Embargoed:
zbyszek: fedora-review+


Attachments (Terms of Use)

Description Ken Dreyer 2015-01-06 21:22:33 UTC
Spec URL: https://ktdreyer.fedorapeople.org/reviews/python-cram.spec
SRPM URL: https://ktdreyer.fedorapeople.org/reviews/python-cram-0.6-1.fc22.src.rpm
Description: Cram tests look like snippets of interactive shell sessions. Cram runs each command and compares the command output in the test with the command's actual output.
Fedora Account System Username: ktdreyer

Rawhide (F22) scratch build: http://koji.fedoraproject.org/koji/taskinfo?taskID=8543492

Comment 1 Ken Dreyer 2015-01-07 00:19:54 UTC
Here's a new version that fixes a bad copy-and-paste in the %description, as well as an rpmlint issue with shebangs.

* Tue Jan 06 2015 Ken Dreyer <ktdreyer> - 0.6-2
- Fix bad copy-and-paste for %%description in python3 subpackage
- Fix shebangs to satisfy rpmlint's non-executable-script errors

Exact change in Git: https://fedorapeople.org/cgit/ktdreyer/public_git/python-cram.git/commit/?id=fbdad6f50d21f049efffeda7142e5b7ff3729b9b

Spec URL: https://ktdreyer.fedorapeople.org/reviews/python-cram.spec
SRPM URL: https://ktdreyer.fedorapeople.org/reviews/python-cram-0.6-2.fc22.src.rpm

Rawhide (F22) scratch build: http://koji.fedoraproject.org/koji/taskinfo?taskID=8544126

Comment 2 Niranjan MR 2015-01-07 08:33:10 UTC
Greetings, 


This is un-official Package review.


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

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



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

Generic:
[ ]: 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". 2 files have unknown license. Detailed output of
     licensecheck in /home/makerpm/review/cram/review-python-
     cram/licensecheck.txt
[ ]: License file installed when any subpackage combination is installed.
[ ]: Package does not own files or directories owned by other packages.
     Note: Dirs in package are owned also by: /usr/lib/python3.4/site-
     packages/__pycache__(python3-setuptools, python3-six, python3-libs)
[ ]: Package contains no bundled libraries without FPC exception.
[ ]: Changelog in prescribed format.
[ ]: 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.
[ ]: Package consistently uses macros (instead of hard-coded directory names).
[ ]: Package is named according to the Package Naming Guidelines.
[ ]: Package does not generate any conflict.
[ ]: 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.
[ ]: Spec file is legible and written in American English.
[ ]: Package contains systemd file(s) if in need.
[ ]: 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 81920 bytes in 18 files.
[ ]: 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 %doc.
[x]: Package requires other packages for directories it uses.
[x]: Package must own all directories that it creates.
[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]: 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 do not use a name that already exist
[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:
[ ]: Python eggs must not download any dependencies during the build process.
[ ]: A package which is used by another package via an egg interface should
     provide egg info.
[ ]: Package meets the Packaging Guidelines::Python
[x]: Package contains BR: python2-devel or python3-devel
[x]: Binary eggs must be removed in %prep

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

Generic:
[!]: Dist tag is present (not strictly required in GL).
[ ]: If the source package does not include license text(s) as a separate file
     from upstream, the packager SHOULD query upstream to include it.
[ ]: Final provides and requires are sane (see attachments).
[ ]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in
     python3-cram
[ ]: Package functions as described.
[ ]: Latest version is packaged.
[ ]: 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.
[ ]: Package should compile and build into binary rpms on all supported
     architectures.
[ ]: %check is present and all tests pass.
[ ]: Packages should try to preserve timestamps of original installed files.
[ ]: Spec use %global instead of %define unless justified.
     Note: %define requiring justification: %define srcname cram
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: Sources can be downloaded from URI in Source: tag
[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]: 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: python-cram-0.6-2.fc22.noarch.rpm
          python3-cram-0.6-2.fc22.noarch.rpm
          python-cram-0.6-2.fc22.src.rpm
python-cram.noarch: E: zero-length /usr/share/doc/python-cram/empty.t
python-cram.noarch: E: incorrect-fsf-address /usr/share/doc/python-cram/COPYING.txt
python-cram.noarch: W: no-manual-page-for-binary cram-2.7
python-cram.noarch: W: no-manual-page-for-binary cram
python3-cram.noarch: W: summary-ended-with-dot C Utilities and processors for the Python Imaging Libary.
python3-cram.noarch: E: zero-length /usr/share/doc/python3-cram/empty.t
python3-cram.noarch: E: incorrect-fsf-address /usr/share/doc/python3-cram/COPYING.txt
python3-cram.noarch: W: no-manual-page-for-binary cram-3.4
3 packages and 0 specfiles checked; 4 errors, 4 warnings.




Rpmlint (installed packages)
----------------------------
^[]0;<mock-chroot>^G<mock-chroot>[root@pki1 /]# rpmlint python-cram python3-cram
python-cram.noarch: E: zero-length /usr/share/doc/python-cram/empty.t
python-cram.noarch: E: incorrect-fsf-address /usr/share/doc/python-cram/COPYING.txt
python-cram.noarch: W: no-manual-page-for-binary cram-2.7
python-cram.noarch: W: no-manual-page-for-binary cram
python3-cram.noarch: W: summary-ended-with-dot C Utilities and processors for the Python Imaging Libary.
python3-cram.noarch: E: zero-length /usr/share/doc/python3-cram/empty.t
python3-cram.noarch: E: incorrect-fsf-address /usr/share/doc/python3-cram/COPYING.txt
python3-cram.noarch: W: no-manual-page-for-binary cram-3.4
2 packages and 0 specfiles checked; 4 errors, 4 warnings.
^[]0;<mock-chroot>^G<mock-chroot>[root@pki1 /]# echo 'rpmlint-done:'



Requires
--------
python-cram (rpmlib, GLIBC filtered):
    /usr/bin/python
    python(abi)

python3-cram (rpmlib, GLIBC filtered):
    /usr/bin/python3
    python(abi)
    python3



Provides
--------
python-cram:
    python-cram


Could you have a look at the rpmlint errors. Specifically the Non man page of some binaries and incorrect fsf address.

Comment 3 Ken Dreyer 2015-01-07 15:55:38 UTC
I don't think the man page issue is going to be fixed, but I've filed a request for the GPL update here: https://bitbucket.org/brodie/cram/pull-request/7/update-gpl-text-in-copyingtxt/diff

Comment 4 Niranjan MR 2015-01-07 16:20:18 UTC
Also all the binaries should have the man page. If not provided, You might require to file request upstream to provide the man page. 

Also regarding the zero length file . 
E: zero-length /usr/share/doc/python3-cram/empty.t
E: zero-length /usr/share/doc/python-cram/empty.t

zero length files should generally not be included. 

Please refer:

https://fedoraproject.org/wiki/Common_Rpmlint_issues#zero-length

https://fedoraproject.org/wiki/Packaging_tricks?rd=PackageMaintainers/Packaging_Tricks#Zero_length_files

Comment 5 Ken Dreyer 2015-01-07 18:30:08 UTC
Hi Niranjan, I appreciate the thoroughness in your review. I've decided to simply stop shipping the .t files that are from the "/examples/" directory. The test suite depends on them, so I can't remove them until after %check is done. And there are multiple rpmlint issues with these (both the empty.t and .hidden.t files trigger rpmlint's warnings).

* Wed Jan 07 2015 Ken Dreyer <ktdreyer> - 0.6-3
- Do not ship examples files in package. These are more like test files.
  (RHBZ #1179484)

Exact change in Git: https://fedorapeople.org/cgit/ktdreyer/public_git/python-cram.git/commit/?id=7c6d4ee60127c2e96fd115701a6f913752d3928f

Spec URL: https://ktdreyer.fedorapeople.org/reviews/python-cram.spec
SRPM URL: https://ktdreyer.fedorapeople.org/reviews/python-cram-0.6-3.fc22.src.rpm

F22 scratch build: http://koji.fedoraproject.org/koji/taskinfo?taskID=8548661

Comment 6 Boris Ranto 2015-01-08 07:58:45 UTC
One more thing: the spec file says the licence is BSD while it should say GPLv2.

Comment 7 Ken Dreyer 2015-01-08 14:47:50 UTC
(In reply to Boris Ranto from comment #6)
> One more thing: the spec file says the licence is BSD while it should say
> GPLv2.

Great catch, sorry about that. It was another bad copy-and-paste from a previous package.

New version:

* Thu Jan 08 2015 Ken Dreyer <ktdreyer> - 0.6-4
- Correct License tag (RHBZ #1179484)

Exact change in Git: https://fedorapeople.org/cgit/ktdreyer/public_git/python-cram.git/commit/?id=b7b1ec572a055a901b60bbc67d80a40726569490

Spec URL: https://ktdreyer.fedorapeople.org/reviews/python-cram.spec
SRPM URL: https://ktdreyer.fedorapeople.org/reviews/python-cram-0.6-4.fc22.src.rpm

Comment 8 Till Maas 2015-02-21 22:53:08 UTC
(In reply to Niranjan MR from comment #2)
> Greetings, 
> 
> 
> This is un-official Package review.
> 
> 
> Package Review
> ==============
> 
> Legend:
> [x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated
> [ ] = Manual review needed
> 
> 
> 
> ===== MUST items =====
> 
> Generic:
> [ ]: Package is licensed with an open-source compatible license and meets
>      other legal requirements as defined in the legal section of Packaging
>      Guidelines.

@Niranjan if you use fedora-review, you still need to go through the checks that need to be done manually and if you checked them add the proper sign to the boxes.

Comment 9 Till Maas 2015-02-21 22:55:16 UTC
COPYING.txt needs to be marked as %license if it contains the license text (this is a recend packaging guideline change)

Comment 10 Ken Dreyer 2015-04-04 19:20:33 UTC
(In reply to Till Maas from comment #9)
> COPYING.txt needs to be marked as %license if it contains the license text

Thanks Till, I've fixed this in the new version.

* Sat Apr 04 2015 Ken Dreyer <ktdreyer> - 0.6-5
- Use %%license macro (RHBZ #1179484)

Exact change in Git: https://fedorapeople.org/cgit/ktdreyer/public_git/python-cram.git/commit/?id=d5270719b327eb08f16e81fbea392c18e6a9461c

Spec URL: https://fedorapeople.org/cgit/ktdreyer/public_git/python-cram.git/plain/python-cram.spec
SRPM URL: https://ktdreyer.fedorapeople.org/reviews/python-cram-0.6-5.fc23.src.rpm

Rawhide (F23) scratch build: http://koji.fedoraproject.org/koji/taskinfo?taskID=9415079

Comment 11 Zbigniew Jędrzejewski-Szmek 2015-12-05 05:25:45 UTC
- Dist tag is not present → add %{?dist} to Release.

You should convert to the new python macros %py2_build, %py2_install, %py3_build, %py3_install, and build python2- and python3- subpackages [https://fedoraproject.org/wiki/Packaging:Python#Example_common_spec_file].

The guidelines say you should provide both cram-2.7 and cram-2, and cram-3.5 and cram-3 [https://fedoraproject.org/wiki/Packaging:Python#Executables_in_.2Fusr.2Fbin].

%{py3dir} is also deprecated. Use a subdirectory instead.

python3-cram.noarch: W: summary-ended-with-dot C Utilities and processors for the Python Imaging Libary.

The python 2 version of the script should use /usr/bin/python2 (i.e. %{__python2}), not /usr/bin/python in the header.

Comment 12 Upstream Release Monitoring 2015-12-06 04:28:36 UTC
ktdreyer's scratch build of python-cram-0.6-6.fc24.src.rpm for rawhide completed http://koji.fedoraproject.org/koji/taskinfo?taskID=12078505

Comment 13 Ken Dreyer 2015-12-06 04:29:29 UTC
Thanks Zbigniew, I've fixed this in the new version.

* Sun Dec 06 2015 Ken Dreyer <ktdreyer> - 0.6-6
- Update for latest Python packaging guidelines (thanks zbyszek.pl)
  (rhbz#1179484)
- rm Group tag
- drop support for el6

Exact change in Git: https://fedorapeople.org/cgit/ktdreyer/public_git/python-cram.git/commit/?id=1fbbb40e40c2e8c60ee758c1f9274201924c5745

Spec URL: https://fedorapeople.org/cgit/ktdreyer/public_git/python-cram.git/plain/python-cram.spec
SRPM URL: https://ktdreyer.fedorapeople.org/reviews/python-cram-0.6-6.fc24.src.rpm

Comment 14 Upstream Release Monitoring 2015-12-06 04:46:55 UTC
ktdreyer's scratch build of python-cram-0.6-7.fc24.src.rpm for rawhide completed http://koji.fedoraproject.org/koji/taskinfo?taskID=12078681

Comment 15 Ken Dreyer 2015-12-06 06:05:42 UTC
Zbigniew, you pointed out some other things that I missed earlier. I've fixed them in this latest version.

* Sun Dec 06 2015 Ken Dreyer <ktdreyer> - 0.6-7
- Correct Summary for python3-cram subpackage (thanks zbyszek.pl)
  (rhbz#1179484)
- rm py3dir macro (thanks zbyszek.pl) (rhbz#1179484)

Exact change in Git: https://fedorapeople.org/cgit/ktdreyer/public_git/python-cram.git/commit/?id=882974e54e5a747603aff8c1e0f0bf29fe848c71

Spec URL: https://fedorapeople.org/cgit/ktdreyer/public_git/python-cram.git/plain/python-cram.spec
SRPM URL: https://ktdreyer.fedorapeople.org/reviews/python-cram-0.6-7.fc24.src.rpm

Comment 16 Zbigniew Jędrzejewski-Szmek 2015-12-06 14:48:09 UTC
python-devel → python2-devel

You can drop the other Group tag (not harmful, just unnecessary).

- license is OK (GPLv2)
- license file is present, %license is used
- latest version
- new python packaging template is used
- provides/requires are OK
- no scriptlets present or needed
- rpmlint:

python2-cram.noarch: E: incorrect-fsf-address /usr/share/licenses/python2-cram/COPYING.txt
python3-cram.noarch: E: incorrect-fsf-address /usr/share/licenses/python3-cram/COPYING.txt

Oh, there's an important thing that I missed. Is it correct to say that the functionality provided by /bin/cram-2 and /bin/cram-3 is the same, i.e. that it is independent of the python version? It seems so. In that case there's no need to package both executables, and no need to add the -3, -3.5, -2.6, -2, symlinks. There should be just one executable /usr/bin/cram, using /usr/bin/python3 [https://fedoraproject.org/wiki/Packaging:Python#Executables_in_.2Fusr.2Fbin].

Comment 17 Upstream Release Monitoring 2015-12-07 03:11:00 UTC
ktdreyer's scratch build of python-cram-0.6-8.fc24.src.rpm for rawhide completed http://koji.fedoraproject.org/koji/taskinfo?taskID=12096520

Comment 18 Ken Dreyer 2015-12-07 03:11:48 UTC
Thanks Zbigniew, this new version addresses your comments.

* Mon Dec 07 2015 Ken Dreyer <ktdreyer> - 0.6-8
- BR: python2-devel instead of python-devel (thanks zbyszek.pl)
  (rhbz#1179484)
- rm Group tag from py3 subpackage (thanks zbyszek.pl) (rhbz#1179484)
- Only package a single executable, /usr/bin/cram (thanks zbyszek.pl)
  (rhbz#1179484)

Exact change in Git: https://fedorapeople.org/cgit/ktdreyer/public_git/python-cram.git/commit/?id=3a48d0a13fbbb6cdd55a5a6e9ad68bee333425f5

Spec URL: https://fedorapeople.org/cgit/ktdreyer/public_git/python-cram.git/plain/python-cram.spec
SRPM URL: https://ktdreyer.fedorapeople.org/reviews/python-cram-0.6-8.fc24.src.rpm

Comment 19 Zbigniew Jędrzejewski-Szmek 2015-12-07 03:44:18 UTC
Suggestions:

- Do not repeat Summary text, just use %{summary} in the second and later ones.

- You can drop the version specificianions for python3 >= 3.1, >= 3.2.4, because the earliest python3 that is available is Fedora is 3.4.

Package is APPROVED.

Comment 20 Ken Dreyer 2015-12-07 15:46:21 UTC
Thank you Zbigniew for the package review. I've incorporated your suggestions in my latest version:

* Mon Dec 07 2015 Ken Dreyer <ktdreyer> - 0.6-9
- Use %%{summary} macro in py2/py3 subpackages (thanks zbyszek.pl)
  (rhbz#1179484)
- Drop old py3 minimum version numbers (thanks zbyszek.pl)
  (rhbz#1179484)

Exact change in Git: https://fedorapeople.org/cgit/ktdreyer/public_git/python-cram.git/commit/?id=f726c44d9e4e7fcea1b4ca37976585f00bdf6122

I've requested the new package in pkgdb.

Comment 21 Gwyn Ciesla 2015-12-07 17:46:06 UTC
Package request has been approved: https://admin.fedoraproject.org/pkgdb/package/python-cram

Comment 22 Fedora Update System 2015-12-07 22:07:37 UTC
python-cram-0.6-9.el7 has been submitted as an update to Fedora EPEL 7. https://bodhi.fedoraproject.org/updates/FEDORA-EPEL-2015-a40317274b

Comment 23 Fedora Update System 2015-12-07 22:08:54 UTC
python-cram-0.6-9.fc23 has been submitted as an update to Fedora 23. https://bodhi.fedoraproject.org/updates/FEDORA-2015-04410bc35c

Comment 24 Fedora Update System 2015-12-07 22:09:14 UTC
python-cram-0.6-9.fc22 has been submitted as an update to Fedora 22. https://bodhi.fedoraproject.org/updates/FEDORA-2015-7eb06b5735

Comment 25 Fedora Update System 2015-12-08 07:20:52 UTC
python-cram-0.6-9.el7 has been pushed to the Fedora EPEL 7 testing repository. If problems still persist, please make note of it in this bug report.
If you want to test the update, you can install it with
$ su -c 'yum --enablerepo=epel-testing update python-cram'
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-EPEL-2015-a40317274b

Comment 26 Fedora Update System 2015-12-08 22:57:59 UTC
python-cram-0.6-9.fc23 has been pushed to the Fedora 23 testing repository. If problems still persist, please make note of it in this bug report.
If you want to test the update, you can install it with
$ su -c 'dnf --enablerepo=updates-testing update python-cram'
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2015-04410bc35c

Comment 27 Fedora Update System 2015-12-08 23:51:12 UTC
python-cram-0.6-9.fc22 has been pushed to the Fedora 22 testing repository. If problems still persist, please make note of it in this bug report.
If you want to test the update, you can install it with
$ su -c 'dnf --enablerepo=updates-testing update python-cram'
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2015-7eb06b5735

Comment 28 Fedora Update System 2016-01-07 19:28:12 UTC
python-cram-0.6-9.el7 has been pushed to the Fedora EPEL 7 stable repository. If problems still persist, please make note of it in this bug report.

Comment 29 Fedora Update System 2016-01-07 19:56:49 UTC
python-cram-0.6-9.fc23 has been pushed to the Fedora 23 stable repository. If problems still persist, please make note of it in this bug report.

Comment 30 Fedora Update System 2016-01-08 03:28:35 UTC
python-cram-0.6-9.fc22 has been pushed to the Fedora 22 stable repository. If problems still persist, please make note of it in this bug report.


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