Bug 1002013 - Review Request: httpdtap - Tool for querying httpd using SystemTap scripts
Summary: Review Request: httpdtap - Tool for querying httpd using SystemTap scripts
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Mario Blättermann
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-08-28 10:41 UTC by Jan Kaluža
Modified: 2014-10-09 19:33 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2014-10-09 19:33:23 UTC
Type: ---
Embargoed:
mario.blaettermann: fedora-review+
gwync: fedora-cvs+


Attachments (Terms of Use)

Description Jan Kaluža 2013-08-28 10:41:22 UTC
Spec URL: http://jkaluza.fedorapeople.org/httpdtap.spec
SRPM URL: http://jkaluza.fedorapeople.org/httpdtap-0.1-1.fc19.src.rpm
Description: HttpdTap is collection of useful SystemTap scripts to query running httpd server to get information like files accessed during a request, time needed to dispatch a request, the list of requests slower than N milliseconds or the list of requests sent from particular IP address. Thanks to SystemTap the performance penalty is very low and therefore the HttpdTap can be used even on production systems.
Fedora Account System Username: jkaluza

Comment 1 Mario Blättermann 2013-08-28 13:04:02 UTC
BuildRequires:  python-devel
is deprecated, use python2-devel instead:
http://fedoraproject.org/wiki/Packaging:Python#BuildRequires

%build
CFLAGS="%{optflags}"
doesn't make sense for a noarch package.

%defattr(-,root,root,-)
is obsolete for ages. RPM now defaults to in Fedora and EPEL >=6.

Comment 3 Mario Blättermann 2013-08-29 15:52:05 UTC
Scratch build:
http://koji.fedoraproject.org/koji/taskinfo?taskID=5870630

$ rpmlint -i -v *
httpdtap.src: I: checking
httpdtap.src: W: spelling-error Summary(en_US) httpd -> HTTP
The value of this tag appears to be misspelled. Please double-check.

httpdtap.src: W: spelling-error %description -l en_US httpd -> HTTP
The value of this tag appears to be misspelled. Please double-check.

httpdtap.src: I: checking-url https://github.com/hanzz/httpdtap (timeout 10 seconds)
httpdtap.src: I: checking-url https://github.com/hanzz/httpdtap/archive/v0.1.tar.gz (timeout 10 seconds)
httpdtap.noarch: I: checking
httpdtap.noarch: E: devel-dependency apr-debuginfo
Your package has a dependency on a devel package but it's not a devel package
itself.

httpdtap.noarch: W: spelling-error Summary(en_US) httpd -> HTTP
The value of this tag appears to be misspelled. Please double-check.

httpdtap.noarch: W: spelling-error %description -l en_US httpd -> HTTP
The value of this tag appears to be misspelled. Please double-check.

httpdtap.noarch: I: checking-url https://github.com/hanzz/httpdtap (timeout 10 seconds)
httpdtap.noarch: E: non-executable-script /usr/share/httpdtap/scripts-24/req_time.stp 0644L /usr/bin/env
This text file contains a shebang or is located in a path dedicated for
executables, but lacks the executable bits and cannot thus be executed.  If
the file is meant to be an executable script, add the executable bits,
otherwise remove the shebang or move the file elsewhere.

httpdtap.noarch: E: non-executable-script /usr/share/httpdtap/scripts-22/req_from.stp 0644L /usr/bin/env
This text file contains a shebang or is located in a path dedicated for
executables, but lacks the executable bits and cannot thus be executed.  If
the file is meant to be an executable script, add the executable bits,
otherwise remove the shebang or move the file elsewhere.

httpdtap.noarch: E: non-executable-script /usr/share/httpdtap/scripts-24/req_files.stp 0644L /usr/bin/env
This text file contains a shebang or is located in a path dedicated for
executables, but lacks the executable bits and cannot thus be executed.  If
the file is meant to be an executable script, add the executable bits,
otherwise remove the shebang or move the file elsewhere.

httpdtap.noarch: E: non-executable-script /usr/share/httpdtap/scripts-22/req_files.stp 0644L /usr/bin/env
This text file contains a shebang or is located in a path dedicated for
executables, but lacks the executable bits and cannot thus be executed.  If
the file is meant to be an executable script, add the executable bits,
otherwise remove the shebang or move the file elsewhere.

httpdtap.noarch: E: non-executable-script /usr/share/httpdtap/scripts-22/req_time.stp 0644L /usr/bin/env
This text file contains a shebang or is located in a path dedicated for
executables, but lacks the executable bits and cannot thus be executed.  If
the file is meant to be an executable script, add the executable bits,
otherwise remove the shebang or move the file elsewhere.

httpdtap.noarch: E: non-executable-script /usr/share/httpdtap/scripts-24/req_slower_than.stp 0644L /usr/bin/env
This text file contains a shebang or is located in a path dedicated for
executables, but lacks the executable bits and cannot thus be executed.  If
the file is meant to be an executable script, add the executable bits,
otherwise remove the shebang or move the file elsewhere.

httpdtap.noarch: E: non-executable-script /usr/share/httpdtap/scripts-22/req_slower_than.stp 0644L /usr/bin/env
This text file contains a shebang or is located in a path dedicated for
executables, but lacks the executable bits and cannot thus be executed.  If
the file is meant to be an executable script, add the executable bits,
otherwise remove the shebang or move the file elsewhere.

httpdtap.noarch: E: non-executable-script /usr/share/httpdtap/scripts-24/req_from.stp 0644L /usr/bin/env
This text file contains a shebang or is located in a path dedicated for
executables, but lacks the executable bits and cannot thus be executed.  If
the file is meant to be an executable script, add the executable bits,
otherwise remove the shebang or move the file elsewhere.

httpdtap.noarch: W: no-manual-page-for-binary httpdtap
Each executable in standard binary directories should have a man page.

httpdtap.spec: I: checking-url https://github.com/hanzz/httpdtap/archive/v0.1.tar.gz (timeout 10 seconds)
2 packages and 1 specfiles checked; 9 errors, 5 warnings.


The devel-dependency warnings are false positive.

What about the non-executable scripts? They should have the executable bit, as far as I can see, unless the scripts are actually modules which will be always called from another script. In the latter case, remove the shebang.

Since you are the upstream author, does it make sense to add man pages to the executable Python script? Maybe with help2man, that's the simplest way in case it has the option --help.

Comment 4 Jan Kaluža 2013-08-30 05:08:21 UTC
(In reply to Mario Blättermann from comment #3)
> What about the non-executable scripts? They should have the executable bit,
> as far as I can see, unless the scripts are actually modules which will be
> always called from another script. In the latter case, remove the shebang.

I will remove shebang. I think I still want to keep them upstream because SystemTap upstream links to them in their scripts database. So they can be used even without httpdtap. But you are right that in Fedora they are supposed to be used only as part of httpdtap.

> Since you are the upstream author, does it make sense to add man pages to
> the executable Python script? Maybe with help2man, that's the simplest way
> in case it has the option --help.

I will do that and add the manpage to the srpm. I will update this review once it's done.

Comment 5 Jan Kaluža 2013-09-10 11:30:58 UTC
Sorry for a delay, all should be done in this new package:

Spec URL: http://jkaluza.fedorapeople.org/httpdtap.spec
SRPM URL: http://jkaluza.fedorapeople.org/httpdtap-0.2-1.fc19.src.rpm

Comment 6 Mario Blättermann 2013-09-21 09:45:39 UTC
Scratch build:
http://koji.fedoraproject.org/koji/taskinfo?taskID=5964169

$ rpmlint -i -v *
httpdtap.src: I: checking
httpdtap.src: W: spelling-error Summary(en_US) httpd -> HTTP
The value of this tag appears to be misspelled. Please double-check.

httpdtap.src: W: spelling-error %description -l en_US httpd -> HTTP
The value of this tag appears to be misspelled. Please double-check.

httpdtap.src: I: checking-url https://github.com/hanzz/httpdtap (timeout 10 seconds)
httpdtap.src: I: checking-url https://github.com/hanzz/httpdtap/archive/v0.2.tar.gz (timeout 10 seconds)
httpdtap.noarch: I: checking
httpdtap.noarch: E: devel-dependency apr-debuginfo
Your package has a dependency on a devel package but it's not a devel package
itself.

httpdtap.noarch: W: spelling-error Summary(en_US) httpd -> HTTP
The value of this tag appears to be misspelled. Please double-check.

httpdtap.noarch: W: spelling-error %description -l en_US httpd -> HTTP
The value of this tag appears to be misspelled. Please double-check.

httpdtap.noarch: I: checking-url https://github.com/hanzz/httpdtap (timeout 10 seconds)
httpdtap.noarch: W: manual-page-warning /usr/share/man/man8/httpdtap.8.gz 1: warning: macro `"' not defined
This man page may contain problems that can cause it not to be formatted as
intended.

httpdtap.spec: I: checking-url https://github.com/hanzz/httpdtap/archive/v0.2.tar.gz (timeout 10 seconds)
2 packages and 1 specfiles checked; 1 errors, 5 warnings.


The spelling erors are ignorable, and the error regarding the devel dependency is false positive.

There is a small cosmetic problem in the man page formatting. You have marked the file header with ." but the proper comment sequence has to be .\". I've found this here: http://liw.fi/manpages/. Well, it doesn't seem to affect the legibility in the man page viewer, that's why I don't consider it as a blocker. Anyway, please fix it before importing your package into the Git repo.


---------------------------------
key:

[+] OK
[.] OK, not applicable
[X] needs work
---------------------------------

[+] MUST: rpmlint must be run on the source rpm and all binary rpms the build produces. The output should be posted in the review.
[+] MUST: The package must be named according to the Package Naming Guidelines.
[+] MUST: The spec file name must match the base package %{name}, in the format %{name}.spec unless your package has an exemption.
[+] MUST: The package must meet the Packaging Guidelines.
[+] MUST: The package must be licensed with a Fedora approved license and meet the Licensing Guidelines.
[+] MUST: The License field in the package spec file must match the actual license.
    ASL 2.0
[+] MUST: 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 must be included in %doc.
[+] MUST: The spec file must be written in American English.
[+] MUST: The spec file for the package MUST be legible.
[+] MUST: The sources used to build the package must match the upstream source, as provided in the spec URL. Reviewers should use sha256sum for this task as it is used by the sources file once imported into git. If no upstream URL can be specified for this package, please see the Source URL Guidelines for how to deal with this.
    $ sha256sum *
    8f68d0c8ceac78ffc5e8aa8467d6739fb3bd547d5e6239131cb51f6f4d9b5f7e  v0.2.tar.gz
    8f68d0c8ceac78ffc5e8aa8467d6739fb3bd547d5e6239131cb51f6f4d9b5f7e  v0.2.tar.gz.orig

[+] MUST: The package MUST successfully compile and build into binary rpms on at least one primary architecture.
[.] MUST: If the package does not successfully compile, build or work on an architecture, then those architectures should be listed in the spec in ExcludeArch. Each architecture listed in ExcludeArch MUST have a bug filed in bugzilla, describing the reason that the package does not compile/build/work on that architecture. The bug number MUST be placed in a comment, next to the corresponding ExcludeArch line.
[+] MUST: All build dependencies must be listed in BuildRequires, except for any that are listed in the exceptions section of the Packaging Guidelines ; inclusion of those as BuildRequires is optional. Apply common sense.
[.] MUST: The spec file MUST handle locales properly. This is done by using the %find_lang macro. Using %{_datadir}/locale/* is strictly forbidden.
[.] MUST: Every binary RPM package (or subpackage) which stores shared library files (not just symlinks) in any of the dynamic linker's default paths, must call ldconfig in %post and %postun.
[.] MUST: Packages must NOT bundle copies of system libraries.
[.] MUST: If the package is designed to be relocatable, the packager must state this fact in the request for review, along with the rationalization for relocation of that specific package. Without this, use of Prefix: /usr is considered a blocker.
[+] MUST: A package must own all directories that it creates. If it does not create a directory that it uses, then it should require a package which does create that directory.
[+] MUST: A Fedora package must not list a file more than once in the spec file's %files listings. (Notable exception: license texts in specific situations)
[+] MUST: Permissions on files must be set properly. Executables should be set with executable permissions, for example.
[+] MUST: Each package must consistently use macros.
[+] MUST: The package must contain code, or permissable content.
[.] MUST: Large documentation files must go in a -doc subpackage. (The definition of large is left up to the packager's best judgement, but is not restricted to size. Large can refer to either size or quantity).
[+] MUST: If a package includes something as %doc, it must not affect the runtime of the application. To summarize: If it is in %doc, the program must run properly if it is not present.
[.] MUST: Static libraries must be in a -static package.
[.] MUST: Development files must be in a -devel package.
[.] MUST: In the vast majority of cases, devel packages must require the base package using a fully versioned dependency: Requires: %{name}%{?_isa} = %{version}-%{release}
[.] MUST: Packages must NOT contain any .la libtool archives, these must be removed in the spec if they are built.
[.] MUST: Packages containing GUI applications must include a %{name}.desktop file, and that file must be properly installed with desktop-file-install in the %install section. If you feel that your packaged GUI application does not need a .desktop file, you must put a comment in the spec file with your explanation.
[+] MUST: Packages must not own files or directories already owned by other packages. The rule of thumb here is that the first package to be installed should own the files or directories that other packages may rely upon. This means, for example, that no package in Fedora should ever share ownership with any of the files or directories owned by the filesystem or man package. If you feel that you have a good reason to own a file or directory that another package owns, then please present that at package review time. 
[+] MUST: All filenames in rpm packages must be valid UTF-8.


[.] SHOULD: If the source package does not include license text(s) as a separate file from upstream, the packager SHOULD query upstream to include it.
[.] SHOULD: The description and summary sections in the package spec file should contain translations for supported Non-English languages, if available.
[+] SHOULD: The reviewer should test that the package builds in mock.
    See Koji build above (which uses Mock anyway).
[+] SHOULD: The package should compile and build into binary rpms on all supported architectures.
[.] SHOULD: The reviewer should test that the package functions as described. A package should not segfault instead of running, for example.
[.] SHOULD: If scriptlets are used, those scriptlets must be sane. This is vague, and left up to the reviewers judgement to determine sanity.
[.] SHOULD: Usually, subpackages other than devel should require the base package using a fully versioned dependency.
[.] SHOULD: The placement of pkgconfig(.pc) files depends on their usecase, and this is usually for development purposes, so should be placed in a -devel pkg. A reasonable exception is that the main pkg itself is a devel tool not installed in a user runtime, e.g. gcc or gdb.
[.] SHOULD: If the package has file dependencies outside of /etc, /bin, /sbin, /usr/bin, or /usr/sbin consider requiring the package which provides the file instead of the file itself.
[+] SHOULD: your package should contain man pages for binaries/scripts. If it doesn't, work with upstream to add them where they make sense.


----------------

PACKAGE APPROVED

----------------

Comment 7 Jan Kaluža 2013-09-23 09:32:55 UTC
Thanks for review. I will fix the remaining problems before import.

Comment 8 Jan Kaluža 2013-09-23 09:35:55 UTC
New Package SCM Request
=======================
Package Name: httpdtap
Short Description: Tool for querying httpd using SystemTap scripts
Owners: jkaluza
Branches: f18 f19 f20

Comment 9 Gwyn Ciesla 2013-09-23 12:42:01 UTC
Git done (by process-git-requests).

Comment 10 Fedora Update System 2013-09-26 06:56:35 UTC
httpdtap-0.2-2.fc20 has been submitted as an update for Fedora 20.
https://admin.fedoraproject.org/updates/httpdtap-0.2-2.fc20

Comment 11 Fedora Update System 2013-09-26 06:57:39 UTC
httpdtap-0.2-2.fc19 has been submitted as an update for Fedora 19.
https://admin.fedoraproject.org/updates/httpdtap-0.2-2.fc19

Comment 12 Fedora Update System 2013-09-26 07:02:49 UTC
httpdtap-0.2-2.fc18 has been submitted as an update for Fedora 18.
https://admin.fedoraproject.org/updates/httpdtap-0.2-2.fc18

Comment 13 Fedora Update System 2013-09-27 00:38:59 UTC
httpdtap-0.2-2.fc18 has been pushed to the Fedora 18 testing repository.

Comment 14 Fedora Update System 2014-04-15 15:05:54 UTC
httpdtap-0.3-1.fc20 has been submitted as an update for Fedora 20.
https://admin.fedoraproject.org/updates/httpdtap-0.3-1.fc20


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