Bug 1801088 - Review request: usbguard-notifier - A tool for detecting usbguard policy and device presence changes
Summary: Review request: usbguard-notifier - A tool for detecting usbguard policy and ...
Keywords:
Status: CLOSED NEXTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Kairui Song
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-02-10 08:49 UTC by Attila Lakatos
Modified: 2020-03-10 10:03 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-03-10 10:03:52 UTC
Type: Bug
Embargoed:
kasong: fedora-review+


Attachments (Terms of Use)

Description Attila Lakatos 2020-02-10 08:49:19 UTC
Spec URL: http://www.stud.fit.vutbr.cz/~xlakat01/usbguard-notifier.spec
SRPM URL: http://www.stud.fit.vutbr.cz/~xlakat01/usbguard-notifier-0.0.2-1.fc31.src.rpm

Description: usbguard-notifier is a software framework mainly for detecting usbguard policy modifications as well as device presence changes. 
It's purpose is to create user-friendly notifications whenever a device is:
 - Plugged in/out
 - Allowed/blocked/rejected via usbguard command-line interface

The biggest benefit of this project is that non-technical users can also easily know when the device they just plugged in is allowed or blocked by the usbguard framework.

usbguard-notifier: https://github.com/Cropi/usbguard-notifier
usbguard: https://github.com/USBGuard/usbguard/

Fedora Account System Username: alakatos

Comment 1 Raphael Groner 2020-02-10 09:51:09 UTC
Are you interested in a review swap?

Comment 2 Attila Lakatos 2020-02-11 09:17:13 UTC
Passing build and additional information: https://copr.fedorainfracloud.org/coprs/alakatos/usbguard-notifier/

Comment 3 Kairui Song 2020-02-17 02:43:08 UTC
(In reply to Attila Lakatos from comment #0)
> Spec URL: http://www.stud.fit.vutbr.cz/~xlakat01/usbguard-notifier.spec
> SRPM URL:
> http://www.stud.fit.vutbr.cz/~xlakat01/usbguard-notifier-0.0.2-1.fc31.src.rpm

Hi, I got a 403 error when trying to access the spec or srpm file, please help fix that, thanks.

> 
> Description: usbguard-notifier is a software framework mainly for detecting
> usbguard policy modifications as well as device presence changes. 
> It's purpose is to create user-friendly notifications whenever a device is:
>  - Plugged in/out
>  - Allowed/blocked/rejected via usbguard command-line interface
> 
> The biggest benefit of this project is that non-technical users can also
> easily know when the device they just plugged in is allowed or blocked by
> the usbguard framework.
> 
> usbguard-notifier: https://github.com/Cropi/usbguard-notifier
> usbguard: https://github.com/USBGuard/usbguard/
> 
> Fedora Account System Username: alakatos

Comment 4 Attila Lakatos 2020-02-17 13:27:13 UTC
(In reply to Kairui Song from comment #3)
> (In reply to Attila Lakatos from comment #0)
> > Spec URL: http://www.stud.fit.vutbr.cz/~xlakat01/usbguard-notifier.spec
> > SRPM URL:
> > http://www.stud.fit.vutbr.cz/~xlakat01/usbguard-notifier-0.0.2-1.fc31.src.rpm
> 
> Hi, I got a 403 error when trying to access the spec or srpm file, please
> help fix that, thanks.

It looks like the links have expired. Here are the new links:
Spec URL: http://www.stud.fit.vutbr.cz/~xlakat01/test/usbguard-notifier.spec
SRPM URL: http://www.stud.fit.vutbr.cz/~xlakat01/test/usbguard-notifier-0.0.3-1.fc31.src.rpm

> 
> > 
> > Description: usbguard-notifier is a software framework mainly for detecting
> > usbguard policy modifications as well as device presence changes. 
> > It's purpose is to create user-friendly notifications whenever a device is:
> >  - Plugged in/out
> >  - Allowed/blocked/rejected via usbguard command-line interface
> > 
> > The biggest benefit of this project is that non-technical users can also
> > easily know when the device they just plugged in is allowed or blocked by
> > the usbguard framework.
> > 
> > usbguard-notifier: https://github.com/Cropi/usbguard-notifier
> > usbguard: https://github.com/USBGuard/usbguard/
> > 
> > Fedora Account System Username: alakatos

Comment 5 Kairui Song 2020-02-18 08:51:05 UTC
Hi, it looks like the link expires too quick? I can access the spec file a few hours ago, now I'm getting 403 error again.

Comment 6 Attila Lakatos 2020-02-18 09:05:22 UTC
(In reply to Kairui Song from comment #5)
> Hi, it looks like the link expires too quick? I can access the spec file a
> few hours ago, now I'm getting 403 error again.

I am really sorry for that, it should work now.

Comment 7 Kairui Song 2020-02-18 15:19:08 UTC
Hi, I found some problems with the spec.

> %build
> mkdir -p ./m4
> autoreconf -i -f -v --no-recursive ./
> %configure \
>     --disable-silent-rules \
>     --without-bundled-catch \
>     --enable-debug-build
> 
> make %{?_smp_mflags}

The build system doesn't seem to honor Fedora's CFLAGS from environment.

> %install
> make install INSTALL='install -p' DESTDIR=%{buildroot}
> execstack -c $RPM_BUILD_ROOT%{_bindir}/*

I never used execstack before, but according to 
https://fedoraproject.org/wiki/Packaging_tricks#Executable_stack
it disables executable stack, but shouldn't the code generated by gcc/g++ have that by default?

> 
> # Cleanup
> find %{buildroot} \( -name '*.o' -o -name '*.a' \) -exec rm -f {} ';'

Clean up is not needed in %install, anything not included by %files is not packaged.

> %files
> %doc README.md CHANGELOG.md
> %license LICENSE
> %{_bindir}/usbguard-notifier
> %{_bindir}/usbguard-notifier-cli
> %{_datadir}/man/man1/usbguard-notifier.1.gz
> %{_datadir}/man/man1/usbguard-notifier-cli.1.gz
> %{_userunitdir}/usbguard-notifier.service

Consider using %{_mandir}
https://docs.fedoraproject.org/en-US/packaging-guidelines/#_manpages

And systemd unit should go to _unitdir, see:
https://docs.fedoraproject.org/en-US/packaging-guidelines/Systemd/#_filesystem_locations

And some issues found by fedora-review:
Issues:
=======
- Package uses either %{buildroot} or $RPM_BUILD_ROOT
  Note: Using both %{buildroot} and $RPM_BUILD_ROOT
  See: https://docs.fedoraproject.org/en-US/packaging-guidelines/#_macros
- systemd_user_post is invoked in %post and systemd_user_preun in %preun
  for Systemd user units service files.
  Note: Systemd user unit service file(s) in usbguard-notifier
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/Scriptlets/#_user_units

Comment 8 Raphael Groner 2020-02-18 16:33:53 UTC
(In reply to Attila Lakatos from comment #6)
> (In reply to Kairui Song from comment #5)
> > Hi, it looks like the link expires too quick? I can access the spec file a
> > few hours ago, now I'm getting 403 error again.
> 
> I am really sorry for that, it should work now.

Why do you not use alakatos.fedorapeople.org? You can ssh to there.
https://fedoraproject.org/wiki/Infrastructure/fedorapeople.org

Comment 9 Attila Lakatos 2020-02-24 11:45:43 UTC
(In reply to Kairui Song from comment #7)
> Hi, I found some problems with the spec.
> 
> > %build
> > mkdir -p ./m4
> > autoreconf -i -f -v --no-recursive ./
> > %configure \
> >     --disable-silent-rules \
> >     --without-bundled-catch \
> >     --enable-debug-build
> > 
> > make %{?_smp_mflags}
> 
> The build system doesn't seem to honor Fedora's CFLAGS from environment.

I removed %{?_smp_mflags}. 

> 
> > %install
> > make install INSTALL='install -p' DESTDIR=%{buildroot}
> > execstack -c $RPM_BUILD_ROOT%{_bindir}/*
> 
> I never used execstack before, but according to 
> https://fedoraproject.org/wiki/Packaging_tricks#Executable_stack
> it disables executable stack, but shouldn't the code generated by gcc/g++
> have that by default?

The compiler I am using generates code that permits stack execution but doesn't actually need it.
In order to disable it I decided to use execstack as it is recommended according to the Packaging guideline.

> 
> > 
> > # Cleanup
> > find %{buildroot} \( -name '*.o' -o -name '*.a' \) -exec rm -f {} ';'
> 
> Clean up is not needed in %install, anything not included by %files is not
> packaged.

Yes, you are right. I removed it.

> 
> > %files
> > %doc README.md CHANGELOG.md
> > %license LICENSE
> > %{_bindir}/usbguard-notifier
> > %{_bindir}/usbguard-notifier-cli
> > %{_datadir}/man/man1/usbguard-notifier.1.gz
> > %{_datadir}/man/man1/usbguard-notifier-cli.1.gz
> > %{_userunitdir}/usbguard-notifier.service
> 
> Consider using %{_mandir}
> https://docs.fedoraproject.org/en-US/packaging-guidelines/#_manpages

I changed it to %{_mandir} as you suggested.

> 
> And systemd unit should go to _unitdir, see:
> https://docs.fedoraproject.org/en-US/packaging-guidelines/Systemd/
> #_filesystem_locations

I had to create a new upstream release in order to ensure that, so here are the new links:
Spec URL: https://alakatos.fedorapeople.org/usbguard-notifier.spec
SRPM URL: https://alakatos.fedorapeople.org/usbguard-notifier-0.0.4-1.fc31.src.rpm

> 
> And some issues found by fedora-review:
> Issues:
> =======
> - Package uses either %{buildroot} or $RPM_BUILD_ROOT
>   Note: Using both %{buildroot} and $RPM_BUILD_ROOT
>   See: https://docs.fedoraproject.org/en-US/packaging-guidelines/#_macros
Done.

> - systemd_user_post is invoked in %post and systemd_user_preun in %preun
>   for Systemd user units service files.
>   Note: Systemd user unit service file(s) in usbguard-notifier
>   See: https://docs.fedoraproject.org/en-US/packaging-
>   guidelines/Scriptlets/#_user_units
Done.

Comment 10 Attila Lakatos 2020-03-02 13:21:43 UTC
The spec file has been modified to ensure that the build system does honor Fedora's CFLAGS from environment.

Spec URL: https://alakatos.fedorapeople.org/usbguard-notifier.spec
SRPM URL: https://alakatos.fedorapeople.org/usbguard-notifier-0.0.5-1.fc31.src.rpm

Comment 11 Kairui Song 2020-03-09 18:01:38 UTC
Looks good to me in every way now, thanks for the spec update.

Some issues reported by review tool should be ignored as this package uses user instance services which confuse the linter.

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

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


Issues:
=======
- systemd_user_post is invoked in %post and systemd_user_preun in %preun
  for Systemd user units service files.
  Note: Systemd user unit service file(s) in usbguard-notifier
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/Scriptlets/#_user_units


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

C/C++:
[x]: Package does not contain kernel modules.
[x]: Package contains no static executables.
[x]: If your application is a C or C++ application you must list a
     BuildRequires against gcc, gcc-c++ or clang.
[x]: Package does not contain any libtool archives (.la)
[x]: Rpath absent or only used for internal libs.

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: "Unknown or generated", "GPL (v2 or later)", "Expat License",
     "FSF Unlimited License (with Retention) GNU General Public License
     (v2)", "FSF Unlimited License (with Retention)", "*No copyright* Boost
     Software License (v1.0) Boost Software License 1.0", "Boost Software
     License (v1.0)", "*No copyright* GNU General Public License (v3.0)",
     "*No copyright* Boost Software License (v1.0)". 184 files have unknown
     license. Detailed output of licensecheck in
     /home/kasong/fedpkg/review/review-usbguard-notifier/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
[x]: %build honors applicable compiler flags or justifies otherwise.
[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.
[x]: Package contains systemd file(s) if in need.
[x]: Useful -debuginfo package or justification otherwise.
[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 10240 bytes in 2 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]: 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]: 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]: 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 must not depend on deprecated() packages.
[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

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

Generic:
[x]: Sources can be downloaded from URI in Source
[-]: 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]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[x]: SourceX tarball generation or download is documented.
     Note: Package contains tarball without URL, check comments
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[-]: 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.
[x]: %check is present and all tests pass.
[-]: 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]: Fully versioned dependency in subpackages if applicable.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: Uses parallel make %{?_smp_mflags} macro.
[x]: SourceX is a working URL.
[x]: Spec use %global instead of %define unless justified.

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

Generic:
[x]: Rpmlint is run on debuginfo package(s).
     Note: No rpmlint messages.
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).
[x]: Large data in /usr/share should live in a noarch subpackage if package
     is arched.
[x]: Package should not use obsolete m4 macros
[x]: Spec file according to URL is the same as in SRPM.

Rpmlint
-------
Checking: usbguard-notifier-0.0.5-1.fc31.x86_64.rpm
          usbguard-notifier-debuginfo-0.0.5-1.fc31.x86_64.rpm
          usbguard-notifier-debugsource-0.0.5-1.fc31.x86_64.rpm
          usbguard-notifier-0.0.5-1.fc31.src.rpm
usbguard-notifier.x86_64: W: empty-%postun
4 packages and 0 specfiles checked; 0 errors, 1 warnings.




Rpmlint (debuginfo)
-------------------
Checking: usbguard-notifier-debuginfo-0.0.5-1.fc31.x86_64.rpm
1 packages and 0 specfiles checked; 0 errors, 0 warnings.



Requires
--------
usbguard-notifier (rpmlib, GLIBC filtered):
    /bin/sh
    libc.so.6()(64bit)
    libgcc_s.so.1()(64bit)
    libgcc_s.so.1(GCC_3.0)(64bit)
    libgobject-2.0.so.0()(64bit)
    libnotify.so.4()(64bit)
    librsvg-2.so.2()(64bit)
    libstdc++.so.6()(64bit)
    libstdc++.so.6(CXXABI_1.3)(64bit)
    libusbguard.so.0()(64bit)
    rtld(GNU_HASH)
    systemd

usbguard-notifier-debuginfo (rpmlib, GLIBC filtered):

usbguard-notifier-debugsource (rpmlib, GLIBC filtered):


Provides
--------
usbguard-notifier:
    usbguard-notifier
    usbguard-notifier(x86-64)

usbguard-notifier-debuginfo:
    debuginfo(build-id)
    usbguard-notifier-debuginfo
    usbguard-notifier-debuginfo(x86-64)

usbguard-notifier-debugsource:
    usbguard-notifier-debugsource
    usbguard-notifier-debugsource(x86-64)

Comment 12 Gwyn Ciesla 2020-03-09 20:45:40 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/usbguard-notifier


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