Bug 1663586 - Review Request: python-kaitaistruct - A new way to develop parsers for binary structures
Summary: Review Request: python-kaitaistruct - A new way to develop parsers for binary...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Elliott Sales de Andrade
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-01-05 00:14 UTC by Dominik 'Rathann' Mierzejewski
Modified: 2019-02-04 13:03 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-02-04 13:03:45 UTC
Type: ---
Embargoed:
quantum.analyst: fedora-review+


Attachments (Terms of Use)

Description Dominik 'Rathann' Mierzejewski 2019-01-05 00:14:42 UTC
Spec URL: https://rathann.fedorapeople.org/review/python-kaitaistruct/python-kaitaistruct.spec
SRPM URL: https://rathann.fedorapeople.org/review/python-kaitaistruct/python-kaitaistruct-0.8-1.fc30.src.rpm
Description:
Kaitai Struct is a declarative language used for describe various binary data
structures, laid out in files or in memory: i.e. binary file formats, network
stream packet formats, etc.

It is similar to Python’s Construct 2.9 but it is language-agnostic. The format
description is done in YAML-based .ksy format, which then can be compiled into a
wide range of target languages.

Fedora Account System Username: rathann

Comment 1 Elliott Sales de Andrade 2019-01-16 04:06:59 UTC
This is probably mostly okay, but the spec and srpm do not match.

Comment 2 Dominik 'Rathann' Mierzejewski 2019-01-16 12:31:58 UTC
(In reply to Elliott Sales de Andrade from comment #1)
> This is probably mostly okay, but the spec and srpm do not match.

Sorry, reuploaded. They should match now.

Spec URL: https://rathann.fedorapeople.org/review/python-kaitaistruct/python-kaitaistruct.spec
SRPM URL: https://rathann.fedorapeople.org/review/python-kaitaistruct/python-kaitaistruct-0.8-2.fc30.src.rpm

* Mon Jan 14 2019 Dominik Mierzejewski <dominik> 0.8-2
- use pypi_source macro
- drop initial newline from description

Comment 3 Elliott Sales de Andrade 2019-01-17 10:45:56 UTC
The description states "Kaitai Struct is a declarative language used for describe ..." which has some sort of verb mismatch. s/for/to/ maybe?
You may also want to ask upstream to provide a separate LICENSE file. I know it's in the readme, but a separate file is easier to find (plus it works with GitHub's automatic license tag.)


Otherwise, approved.


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.
[-]: 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]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated". 6 files have unknown license. Detailed
     output of licensecheck in 1663586-python-kaitaistruct/licensecheck.txt
[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.
[?]: 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.
[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 1 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.
[x]: 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:
[!]: 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.
[-]: 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.
[x]: Packages should try to preserve timestamps of original installed
     files.
[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.
[x]: Spec use %global instead of %define unless justified.

===== 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: python3-kaitaistruct-0.8-2.fc30.noarch.rpm
          python-kaitaistruct-0.8-2.fc30.src.rpm
python3-kaitaistruct.noarch: W: spelling-error Summary(en_US) parsers -> parser, parses, parers
python3-kaitaistruct.noarch: W: spelling-error %description -l en_US Kaitai -> Kaitlin
python3-kaitaistruct.noarch: W: spelling-error %description -l en_US ksy -> sky, ks, key
python-kaitaistruct.src: W: spelling-error Summary(en_US) parsers -> parser, parses, parers
python-kaitaistruct.src: W: spelling-error %description -l en_US Kaitai -> Kaitlin
python-kaitaistruct.src: W: spelling-error %description -l en_US ksy -> sky, ks, key
2 packages and 0 specfiles checked; 0 errors, 6 warnings.




Rpmlint (installed packages)
----------------------------
Cannot parse rpmlint output:


Requires
--------
python3-kaitaistruct (rpmlib, GLIBC filtered):
    python(abi)



Provides
--------
python3-kaitaistruct:
    python3-kaitaistruct
    python3.7dist(kaitaistruct)
    python3dist(kaitaistruct)



Source checksums
----------------
https://files.pythonhosted.org/packages/source/k/kaitaistruct/kaitaistruct-0.8.tar.gz :
  CHECKSUM(SHA256) this package     : d1d17c7f6839b3d28fc22b21295f787974786c2201e8788975e72e2a1d109ff5
  CHECKSUM(SHA256) upstream package : d1d17c7f6839b3d28fc22b21295f787974786c2201e8788975e72e2a1d109ff5


Generated by fedora-review 0.6.1 (f03e4e7) last change: 2016-05-02
Command line :/usr/bin/fedora-review -b 1663586 -m fedora-rawhide-x86_64
Buildroot used: fedora-rawhide-x86_64
Active plugins: Python, Generic, Shell-api
Disabled plugins: Java, C/C++, fonts, SugarActivity, Ocaml, Perl, Haskell, R, PHP
Disabled flags: EXARCH, DISTTAG, EPEL5, BATCH, EPEL6

Comment 4 Dominik 'Rathann' Mierzejewski 2019-01-18 11:18:46 UTC
(In reply to Elliott Sales de Andrade from comment #3)
> The description states "Kaitai Struct is a declarative language used for
> describe ..." which has some sort of verb mismatch. s/for/to/ maybe?
> You may also want to ask upstream to provide a separate LICENSE file. I know
> it's in the readme, but a separate file is easier to find (plus it works
> with GitHub's automatic license tag.)
> 
> 
> Otherwise, approved.

Thanks for the review, Elliott.

I'll fix the description. There are already several issues open upstream asking to include the license texts explicitly:
https://github.com/kaitai-io/kaitai_struct/issues/474
https://github.com/kaitai-io/kaitai_struct/issues/265
https://github.com/kaitai-io/kaitai_struct/issues/264

Comment 5 Gwyn Ciesla 2019-01-18 14:00:22 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-kaitaistruct

Comment 6 Fedora Update System 2019-01-25 15:12:57 UTC
python-kaitaistruct-0.8-2.fc29 has been submitted as an update to Fedora 29. https://bodhi.fedoraproject.org/updates/FEDORA-2019-8dcf7351f6

Comment 7 Fedora Update System 2019-01-26 03:29:16 UTC
python-kaitaistruct-0.8-2.fc29 has been pushed to the Fedora 29 testing repository. If problems still persist, please make note of it in this bug report.
See https://fedoraproject.org/wiki/QA:Updates_Testing for
instructions on how to install test updates.
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2019-8dcf7351f6

Comment 8 Fedora Update System 2019-02-04 13:03:45 UTC
python-kaitaistruct-0.8-2.fc29 has been pushed to the Fedora 29 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.