Bug 727323 - Review Request: vios-proxy - Network proxy between a QEMU host and QEMU guests using virtioserial channels
Summary: Review Request: vios-proxy - Network proxy between a QEMU host and QEMU guest...
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Nuno Santos
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: 721119
TreeView+ depends on / blocked
 
Reported: 2011-08-01 20:02 UTC by Ted Ross
Modified: 2013-09-12 22:12 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2011-09-29 13:10:09 UTC
Type: ---
Embargoed:
lhh: fedora-review+
gwync: fedora-cvs+


Attachments (Terms of Use)
Spec file which resolves most of these initial issues. (2.13 KB, text/plain)
2011-08-15 22:35 UTC, Lon Hohberger
no flags Details
Resolves missing honoring of compiler flags (2.17 KB, text/plain)
2011-08-15 23:18 UTC, Lon Hohberger
no flags Details

Description Ted Ross 2011-08-01 20:02:14 UTC
Spec URL: http://tross.fedorapeople.org/vios-proxy.spec
SRPM URL: http://tross.fedorapeople.org/vios-proxy-0.1-1.fc14.src.rpm
Description: The vios-proxy program suite creates a network tunnel between a server in the QEMU host and a client in a QEMU guest. The proxied server and client programs open normal TCP network ports on localhost and the vios-proxy tunnel connects them using QEMU virtioserial channels.

Comment 1 Lon Hohberger 2011-08-15 22:32:38 UTC
[root@localhost SPECS]# rpmlint vios-proxy.spec 
vios-proxy.spec: W: invalid-url Source0: vios-proxy-0.1.tar.gz
0 packages and 1 specfiles checked; 0 errors, 1 warnings.

[root@localhost SPECS]# rpmlint ../SRPMS/vios-proxy-0.1-1.fc15.src.rpm 
vios-proxy.src: W: spelling-error Summary(en_US) virtioserial -> serialization
vios-proxy.src: W: spelling-error %description -l en_US proxied -> proxies
vios-proxy.src: W: spelling-error %description -l en_US localhost -> local host, local-host, holocaust
vios-proxy.src: W: spelling-error %description -l en_US virtioserial -> serialization
vios-proxy.src: E: no-changelogname-tag
vios-proxy.src: W: invalid-license Apache License, Version 2.0
vios-proxy.src: W: invalid-url Source0: vios-proxy-0.1.tar.gz
1 packages and 0 specfiles checked; 1 errors, 6 warnings.

[root@localhost x86_64]# rpmlint vios-proxy-0.1-1.fc15.x86_64.rpm 
vios-proxy.x86_64: W: spelling-error Summary(en_US) virtioserial -> serialization
vios-proxy.x86_64: W: spelling-error %description -l en_US proxied -> proxies
vios-proxy.x86_64: W: spelling-error %description -l en_US localhost -> local host, local-host, holocaust
vios-proxy.x86_64: W: spelling-error %description -l en_US virtioserial -> serialization
vios-proxy.x86_64: E: no-changelogname-tag
vios-proxy.x86_64: W: invalid-license Apache License, Version 2.0
vios-proxy.x86_64: E: no-binary
vios-proxy.x86_64: W: no-documentation
1 packages and 0 specfiles checked; 2 errors, 6 warnings.

[root@localhost x86_64]# rpmlint vios-proxy-guest-0.1-1.fc15.x86_64.rpm
vios-proxy-guest.x86_64: W: spelling-error Summary(en_US) virtioserial -> serialization
vios-proxy-guest.x86_64: W: spelling-error %description -l en_US localhost -> local host, local-host, holocaust
vios-proxy-guest.x86_64: E: no-changelogname-tag
vios-proxy-guest.x86_64: W: invalid-license Apache License, Version 2.0
vios-proxy-guest.x86_64: W: no-documentation
vios-proxy-guest.x86_64: E: dir-or-file-in-usr-local /usr/local/bin/vios-proxy-guest
1 packages and 0 specfiles checked; 2 errors, 4 warnings.

[root@localhost x86_64]# rpmlint vios-proxy-guest-0.1-1.fc15.x86_64.rpm
vios-proxy-guest.x86_64: W: spelling-error Summary(en_US) virtioserial -> serialization
vios-proxy-guest.x86_64: W: spelling-error %description -l en_US localhost -> local host, local-host, holocaust
vios-proxy-guest.x86_64: E: no-changelogname-tag
vios-proxy-guest.x86_64: W: invalid-license Apache License, Version 2.0
vios-proxy-guest.x86_64: W: no-documentation
vios-proxy-guest.x86_64: E: dir-or-file-in-usr-local /usr/local/bin/vios-proxy-guest
1 packages and 0 specfiles checked; 2 errors, 4 warnings.

[root@localhost x86_64]# rpmlint vios-proxy-host-0.1-1.fc15.x86_64.rpm 
vios-proxy-host.x86_64: W: spelling-error Summary(en_US) virtioserial -> serialization
vios-proxy-host.x86_64: W: spelling-error %description -l en_US proxied -> proxies
vios-proxy-host.x86_64: W: spelling-error %description -l en_US virtioserial -> serialization
vios-proxy-host.x86_64: E: no-changelogname-tag
vios-proxy-host.x86_64: W: invalid-license Apache License, Version 2.0
vios-proxy-host.x86_64: W: no-documentation
vios-proxy-host.x86_64: E: dir-or-file-in-usr-local /usr/local/bin/vios-proxy-host
1 packages and 0 specfiles checked; 2 errors, 5 warnings.


Ignoring the reported spelling errors:

 * Change license to 'ASL 2.0' to appease rpmlint

 * The tarball URL should reflect a project home page; redhat.com usually does not qualify.

 * The Source0: should be a link to download the latest upstream package (may contain macros; e.g. http://my-projects.org/foo/%{name}-%{version}.tar.gz

 * There's no content in vios-proxy-0.1-1 package - it's completely empty.

 * Add a changelog to the %changelog
   15 Aug 2011 Ted Ross <tross> 0.1-1
   * Initial revision
 
Other notes:

 * There are no man pages for the applications.

 * The installation is pointing at /usr/local/bin; these should be in /usr/bin or /usr/sbin on a normal Fedora installation

Comment 2 Lon Hohberger 2011-08-15 22:35:07 UTC
Created attachment 518363 [details]
Spec file which resolves most of these initial issues.

Here is a spec file which resolves the errors (but not the warnings):


[root@localhost SPECS]# rpmlint vios-proxy.spec 
vios-proxy.spec: W: invalid-url Source0: vios-proxy-0.1.tar.gz
0 packages and 1 specfiles checked; 0 errors, 1 warnings.

[root@localhost SPECS]# rpmlint  ../SRPMS/vios-proxy-0.1-1.fc15.src.rpm 
vios-proxy.src: W: spelling-error Summary(en_US) virtioserial -> serialization
vios-proxy.src: W: spelling-error %description -l en_US proxied -> proxies
vios-proxy.src: W: spelling-error %description -l en_US localhost -> local host, local-host, holocaust
vios-proxy.src: W: spelling-error %description -l en_US virtioserial -> serialization
vios-proxy.src: W: invalid-url Source0: vios-proxy-0.1.tar.gz
1 packages and 0 specfiles checked; 0 errors, 5 warnings.

[root@localhost SPECS]# rpmlint  ../RPMS/x86_64/vios-proxy-host-0.1-1.fc15.x86_64.rpm 
vios-proxy-host.x86_64: W: spelling-error Summary(en_US) virtioserial -> serialization
vios-proxy-host.x86_64: W: spelling-error %description -l en_US proxied -> proxies
vios-proxy-host.x86_64: W: spelling-error %description -l en_US virtioserial -> serialization
vios-proxy-host.x86_64: W: no-documentation
vios-proxy-host.x86_64: W: no-manual-page-for-binary vios-proxy-host
1 packages and 0 specfiles checked; 0 errors, 5 warnings.

[root@localhost SPECS]# rpmlint  ../RPMS/x86_64/vios-proxy-guest-0.1-1.fc15.x86_64.rpm 
vios-proxy-guest.x86_64: W: spelling-error Summary(en_US) virtioserial -> serialization
vios-proxy-guest.x86_64: W: spelling-error %description -l en_US localhost -> local host, local-host, holocaust
vios-proxy-guest.x86_64: W: no-documentation
vios-proxy-guest.x86_64: W: no-manual-page-for-binary vios-proxy-guest
1 packages and 0 specfiles checked; 0 errors, 4 warnings.

Comment 3 Lon Hohberger 2011-08-15 23:18:49 UTC
Created attachment 518371 [details]
Resolves missing honoring of compiler flags

This spec file resolves the previously-resolved bits as well as the missing compiler flags as noted on the Fedora Packaging Guidelines page.


Please:

* evaluate the changes present in this spec file as compared to the initial spec file provided in the review request,

* update the spec file to provide a link to an upstream tarball so I can validate the content of the source tarball provided in your initial source RPM,

* update the source spec file and RPM to reflect any changes made (including the examples I provided)

I believe those are the only blocking issues on the 'MUST' list for Fedora inclusion; once that is complete, I will proceed through the 'SHOULD' list (which are not requirements, but strong recommendations).

Comment 4 Nuno Santos 2011-09-19 19:10:14 UTC
Lon: I'm taking over the review from Ted, and am working with Chuck Rolke -- the original developer -- to get it through the process. Will post an updated specfile soon.

Comment 5 Lon Hohberger 2011-09-20 14:10:23 UTC
Sure, hit me up on IRC and I'll complete the review.

Most of the work getting the spec file cleaned up, I provided for you/Ted as an attachment here; it's just the source URL that needs updating and I think we're good.

Comment 6 Nuno Santos 2011-09-20 16:22:50 UTC
Updated spec and srpm can be found here:

Spec URL: http://nsantos.fedorapeople.org/vios-proxy.spec
SRPM URL: http://nsantos.fedorapeople.org/vios-proxy-0.1-1.fc14.src.rpm

Comment 7 Lon Hohberger 2011-09-20 19:36:05 UTC
[root@localhost SPECS]# rpmlint /root/rpmbuild/SRPMS/vios-proxy-0.1-1.fc15.src.rpm

vios-proxy.src: W: spelling-error Summary(en_US) virtioserial -> serialization
vios-proxy.src: W: spelling-error %description -l en_US localhost -> local host, local-host, holocaust
vios-proxy.src: W: spelling-error %description -l en_US virtioserial -> serialization
1 packages and 0 specfiles checked; 0 errors, 3 warnings.
[root@localhost SPECS]# 
[root@localhost SPECS]# rpmlint /root/rpmbuild/RPMS/x86_64/vios-proxy-host-0.1-1.fc15.x86_64.rpm
vios-proxy-host.x86_64: W: spelling-error Summary(en_US) virtioserial -> serialization
vios-proxy-host.x86_64: W: spelling-error %description -l en_US virtioserial -> serialization
rpmlvios-proxy-host.x86_64: W: no-manual-page-for-binary vios-proxy-host
1 packages and 0 specfiles checked; 0 errors, 3 warnings.
i[root@localhost SPECS]# rpmlint /root/rpmbuild/RPMS/x86_64/vios-proxy-guest-0.1-1.fc15.x8_64.rpm

vios-proxy-guest.x86_64: W: spelling-error Summary(en_US) virtioserial -> serialization
vios-proxy-guest.x86_64: W: spelling-error %description -l en_US localhost -> local host, local-host, holocaust
vios-proxy-guest.x86_64: W: no-manual-page-for-binary vios-proxy-guest
1 packages and 0 specfiles checked; 0 errors, 3 warnings.
[root@localhost SPECS]# 
[root@localhost SPECS]# rpmlint  /root/rpmbuild/RPMS/x86_64/vios-proxy-doc-0.1-1.fc15.x86_64.rpm

vios-proxy-doc.x86_64: W: spelling-error %description -l en_US localhost -> local host, local-host, holocaust
vios-proxy-doc.x86_64: W: spelling-error %description -l en_US virtioserial -> serialization
1 packages and 0 specfiles checked; 0 errors, 2 warnings.
[root@localhost SPECS]# 
[root@localhost SPECS]# rpmlint  /root/rpmbuild/RPMS/x86_64/vios-proxy-debuginfo-0.1-1.fc15.x86_64.rpm

1 packages and 0 specfiles checked; 0 errors, 0 warnings.
[root@localhost SPECS]# rpmlint vios-proxy.spec 
0 packages and 1 specfiles checked; 0 errors, 0 warnings.

OK

Comment 8 Lon Hohberger 2011-09-20 19:37:39 UTC
# MUST: rpmlint must be run on the source rpm and all binary rpms the build produces. The output should be posted in the review.[1]

DONE

# MUST: The package must be named according to the Package Naming Guidelines .

PASS

# MUST: The spec file name must match the base package %{name}, in the format %{name}.spec unless your package has an exemption. [2] .

PASS

# MUST: The package must meet the Packaging Guidelines .

PASS

# MUST: The package must be licensed with a Fedora approved license and meet the Licensing Guidelines .

PASS

# MUST: The License field in the package spec file must match the actual license. [3]

PASS

# 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.[4]

PASS, license text included (in doc package, since there is no "main" package).

# MUST: The spec file must be written in American English. [5]

PASS

# MUST: The spec file for the package MUST be legible. [6]

PASS

# MUST: The sources used to build the package must match the upstream source, as provided in the spec URL. Reviewers should use md5sum for this task. If no upstream URL can be specified for this package, please see the Source URL Guidelines for how to deal with this.

PASS

# MUST: The package MUST successfully compile and build into binary rpms on at least one primary architecture. [7]

PASS, x86_64

# 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. [8]

N/A

# 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.

PASS

# MUST: The spec file MUST handle locales properly. This is done by using the %find_lang macro. Using %{_datadir}/locale/* is strictly forbidden.[9]

N/A

# 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. [10]

N/A

# MUST: Packages must NOT bundle copies of system libraries.[11]

PASS

# 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. [12]

PASS

# 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. [13]

PASS

# 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)[14]

PASS

# MUST: Permissions on files must be set properly. Executables should be set with executable permissions, for example. [15]

PASS

# MUST: Each package must consistently use macros. [16]

PASS

# MUST: The package must contain code, or permissable content. [17]

PASS, code

# 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). [18]

PASS

# 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. [18]

N/A

# MUST: Header files must be in a -devel package. [19]

N/A

# MUST: Static libraries must be in a -static package. [20]

N/A

# MUST: If a package contains library files with a suffix (e.g. libfoo.so.1.1), then library files that end in .so (without suffix) must go in a -devel package. [19]

N/A

# MUST: In the vast majority of cases, devel packages must require the base package using a fully versioned dependency: Requires: %{name}%{?_isa} = %{version}-%{release} [21]

N/A

# MUST: Packages must NOT contain any .la libtool archives, these must be removed in the spec if they are built.[20]

N/A

# 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. [22]

N/A

# 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. [23]

PASS

# MUST: All filenames in rpm packages must be valid UTF-8. [24]

PASS

Comment 9 Lon Hohberger 2011-09-20 19:56:16 UTC
# 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. [25]

N/A; text included

# SHOULD: The description and summary sections in the package spec file should contain translations for supported Non-English languages, if available. [26]

N/A; none available

# SHOULD: The reviewer should test that the package builds in mock. [27]

Rebuilt in mock.  Also submitted to koji:
http://koji.fedoraproject.org/koji/taskinfo?taskID=3365692
(Note - scratch build)

# SHOULD: The package should compile and build into binary rpms on all supported architectures. [28]

Rebuilt on i686 on F14.
Koji run against rawhide.

# SHOULD: The reviewer should test that the package functions as described. A package should not segfault instead of running, for example.

Did not test.

# SHOULD: If scriptlets are used, those scriptlets must be sane. This is vague, and left up to the reviewers judgement to determine sanity. [29]

N/A none are used.

# SHOULD: Usually, subpackages other than devel should require the base package using a fully versioned dependency. [21]

There is no main package; sub packages are doc or standalone binaries.  It is
my belief that this suggestion does not apply at the moment.

# 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. [30]

N/A There are no .pc files

# 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. [31]

PASS

# SHOULD: your package should contain man pages for binaries/scripts. If it doesn't, work with upstream to add them where they make sense.[32]

This is future work for the package maintainer; the binaries do not have
manual pages.  The -doc package provides documentation in .odt format.

Comment 10 Lon Hohberger 2011-09-20 19:58:43 UTC
ACCEPT

Comment 11 Nuno Santos 2011-09-20 20:03:18 UTC
New Package SCM Request
=======================
Package Name: vios-proxy
Short Description: The vios-proxy program suite creates a network tunnel between
a server in the QEMU host and a client in a QEMU guest. The proxy server and client programs open normal TCP network ports on localhost and the vios-proxy tunnel connects them using QEMU virtioserial channels.
Owners: chug nsantos
Branches: f16
InitialCC:

Comment 12 Gwyn Ciesla 2011-09-20 20:11:54 UTC
chug is not a valid, sponsored packager username in FAS.

Comment 13 Nuno Santos 2011-09-21 18:38:43 UTC
Ok, I've removed chug as co-owner, and I'll follow the mentorship process (https://fedoraproject.org/wiki/How_to_get_sponsored_into_the_packager_group#Become_a_co-maintainer) to add him as a co-owner later.


New Package SCM Request
=======================
Package Name: vios-proxy
Short Description: The vios-proxy program suite creates a network tunnel
between
a server in the QEMU host and a client in a QEMU guest. The proxy server and
client programs open normal TCP network ports on localhost and the vios-proxy
tunnel connects them using QEMU virtioserial channels.
Owners: nsantos
Branches: f16
InitialCC:

Comment 14 Jason Tibbitts 2011-09-21 22:21:40 UTC
Could you provide a short description which is actually short?  Say, one that fits in 80 characters or so?  The Summary: field from the package is usually a good start, since rpmlint will complain about it if it's too long and I assume that all rpmlint issues were addressed earlier in the review.

Comment 15 Nuno Santos 2011-09-21 23:05:28 UTC
Sure, please use:

Short Description: Network proxy between a QEMU host and QEMU guests using virtioserial channels

Comment 16 Gwyn Ciesla 2011-09-24 15:34:56 UTC
Git done (by process-git-requests).

Edited.  Please re-post the edited SCM request in the future, to save time. 
Thanks!


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