Bug 1871452 - Review Request: ghc-atomic-write - Atomically write to a file
Summary: Review Request: ghc-atomic-write - Atomically write to a file
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Robert-André Mauchin 🐧
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: 1871697
TreeView+ depends on / blocked
 
Reported: 2020-08-23 17:15 UTC by Jens Petersen
Modified: 2020-09-25 16:42 UTC (History)
2 users (show)

Fixed In Version: ghc-atomic-write-0.2.0.7-1.fc34
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-09-25 16:42:15 UTC
Type: ---
Embargoed:
zebob.m: fedora-review+


Attachments (Terms of Use)

Description Jens Petersen 2020-08-23 17:15:18 UTC
Spec URL: https://petersen.fedorapeople.org/reviews/ghc-atomic-write/ghc-atomic-write.spec
SRPM URL: https://petersen.fedorapeople.org/reviews/ghc-atomic-write/ghc-atomic-write-0.2.0.7-1.fc33.src.rpm

Description:
Atomically write to a file on POSIX-compliant systems while preserving
permissions.

On most Unix systems, `mv` is an atomic operation. This makes it simple to
write to a file atomically just by using the mv operation. However, this will
destroy the permissions on the original file. This library does the following
to preserve permissions while atomically writing to a file:

* If an original file exists, take those permissions and apply them to the temp
file before `mv`ing the file into place.

* If the original file does not exist, create a following with default
permissions (based on the currently-active umask).

This way, when the file is `mv`'ed into place, the permissions will be the ones
held by the original file.

This library is based on similar implementations found in common libraries in
Ruby and Python:

* <http://apidock.com/rails/File/atomic_write/class Ruby on Rails includes a
similar method called atomic_write>

* <https://github.com/chef/chef/blob/c4631816132fcfefaba3d123a1d0dfe8bc2866bb/lib/chef/file_content_management/deploy/mv_unix.rb#L23:L71
Chef includes atomic update functionality>

* <https://github.com/sashka/atomicfile There is a python library for
atomically updating a file>

To use `atomic-write`, import the module corresponding to the type you wish to
write atomically, e.g., to write a (strict) ByteString atomically:

> import System.AtomicWrite.Writer.ByteString

Then you can use the atomicWriteFile function that accepts a `FilePath` and a
`ByteString`, e.g.:

> atomicWriteFile myFilePath myByteString.


Koji scratch build: https://koji.fedoraproject.org/koji/taskinfo?taskID=49980469

Comment 1 Robert-André Mauchin 🐧 2020-08-27 15:38:42 UTC
Package approved.



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

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


Issues:
=======
- If your application is a C or C++ application you must list a
  BuildRequires against gcc, gcc-c++ or clang.
  Note: No gcc, gcc-c++ or clang found in BuildRequires
  See: https://docs.fedoraproject.org/en-US/packaging-guidelines/C_and_C++/


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

C/C++:
[x]: Package does not contain kernel modules.
[x]: Package contains no static executables.
[x]: Development (unversioned) .so files in -devel subpackage, if present.
     Note: Unversioned so-files in private %_libdir subdirectory (see
     attachment). Verify they are not in ld path.
[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: "Expat License", "Unknown or generated". 26 files have unknown
     license. Detailed output of licensecheck in
     /home/bob/packaging/review/ghc-atomic-write/review-ghc-atomic-
     write/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
[x]: Package does not own files or directories owned by other packages.
[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.
[x]: 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.
[-]: Package contains systemd file(s) if in need.
[-]: Useful -debuginfo package or justification otherwise.
[x]: Package is not known to require an ExcludeArch tag.
[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 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]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 0 bytes in 0 files.
[x]: Packages must not store files under /srv, /opt or /usr/local

===== 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.
[-]: 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.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[x]: %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]: Fully versioned dependency in subpackages if applicable.
[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]: Large data in /usr/share should live in a noarch subpackage if package
     is arched.
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: ghc-atomic-write-0.2.0.7-1.fc34.x86_64.rpm
          ghc-atomic-write-devel-0.2.0.7-1.fc34.x86_64.rpm
          ghc-atomic-write-0.2.0.7-1.fc34.src.rpm
ghc-atomic-write.x86_64: W: spelling-error %description -l en_US mv -> m, v, me
ghc-atomic-write.x86_64: W: spelling-error %description -l en_US ing -> ING, inf, in
ghc-atomic-write.x86_64: W: spelling-error %description -l en_US umask -> mask, unmask, u mask
ghc-atomic-write.x86_64: W: spelling-error %description -l en_US apidock -> paddock
ghc-atomic-write.x86_64: W: spelling-error %description -l en_US https -> HTTP
ghc-atomic-write.x86_64: W: spelling-error %description -l en_US github -> git hub, git-hub, GitHub
ghc-atomic-write.x86_64: W: spelling-error %description -l en_US unix -> UNIX, Unix, uni
ghc-atomic-write.x86_64: W: spelling-error %description -l en_US rb -> Rb, r, b
ghc-atomic-write.x86_64: W: spelling-error %description -l en_US sashka -> sash
ghc-atomic-write.x86_64: W: spelling-error %description -l en_US atomicfile -> atomic file, atomic-file, atomically
ghc-atomic-write.x86_64: W: spelling-error %description -l en_US AtomicWrite -> Atomic Write, Atomic-write, Micrometeorite
ghc-atomic-write.x86_64: W: spelling-error %description -l en_US ByteString -> Byte String, Byte-string, Restringing
ghc-atomic-write.x86_64: W: spelling-error %description -l en_US atomicWriteFile -> micrometeorite
ghc-atomic-write.x86_64: W: spelling-error %description -l en_US myFilePath -> telepathy
ghc-atomic-write.x86_64: W: spelling-error %description -l en_US myByteString -> restringing
ghc-atomic-write.x86_64: E: description-line-too-long C * <https://github.com/chef/chef/blob/c4631816132fcfefaba3d123a1d0dfe8bc2866bb/lib/chef/file_content_management/deploy/mv_unix.rb#L23:L71
ghc-atomic-write.x86_64: W: library-not-linked-against-libc /usr/lib64/libHSatomic-write-0.2.0.7-2T9Qcmt1Uky1TLEJV4yszz-ghc8.8.4.so
ghc-atomic-write.x86_64: W: no-documentation
ghc-atomic-write-devel.x86_64: W: no-documentation
ghc-atomic-write.src: W: spelling-error %description -l en_US mv -> m, v, me
ghc-atomic-write.src: W: spelling-error %description -l en_US ing -> ING, inf, in
ghc-atomic-write.src: W: spelling-error %description -l en_US umask -> mask, unmask, u mask
ghc-atomic-write.src: W: spelling-error %description -l en_US apidock -> paddock
ghc-atomic-write.src: W: spelling-error %description -l en_US https -> HTTP
ghc-atomic-write.src: W: spelling-error %description -l en_US github -> git hub, git-hub, GitHub
ghc-atomic-write.src: W: spelling-error %description -l en_US unix -> UNIX, Unix, uni
ghc-atomic-write.src: W: spelling-error %description -l en_US rb -> Rb, r, b
ghc-atomic-write.src: W: spelling-error %description -l en_US sashka -> sash
ghc-atomic-write.src: W: spelling-error %description -l en_US atomicfile -> atomic file, atomic-file, atomically
ghc-atomic-write.src: W: spelling-error %description -l en_US AtomicWrite -> Atomic Write, Atomic-write, Micrometeorite
ghc-atomic-write.src: W: spelling-error %description -l en_US ByteString -> Byte String, Byte-string, Restringing
ghc-atomic-write.src: W: spelling-error %description -l en_US atomicWriteFile -> micrometeorite
ghc-atomic-write.src: W: spelling-error %description -l en_US myFilePath -> telepathy
ghc-atomic-write.src: W: spelling-error %description -l en_US myByteString -> restringing
ghc-atomic-write.src: E: description-line-too-long C * <https://github.com/chef/chef/blob/c4631816132fcfefaba3d123a1d0dfe8bc2866bb/lib/chef/file_content_management/deploy/mv_unix.rb#L23:L71
3 packages and 0 specfiles checked; 2 errors, 33 warnings.

Comment 2 Jens Petersen 2020-08-28 03:39:36 UTC
Thank you for the review

https://pagure.io/releng/fedora-scm-requests/issue/27996

Comment 3 Igor Raits 2020-08-28 06:58:40 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/ghc-atomic-write

Comment 4 Fedora Update System 2020-09-02 02:58:20 UTC
FEDORA-2020-ce7cc4dfc4 has been submitted as an update to Fedora 33. https://bodhi.fedoraproject.org/updates/FEDORA-2020-ce7cc4dfc4

Comment 5 Fedora Update System 2020-09-02 16:19:57 UTC
FEDORA-2020-ce7cc4dfc4 has been pushed to the Fedora 33 testing repository.
In short time you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --advisory=FEDORA-2020-ce7cc4dfc4 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2020-ce7cc4dfc4

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 6 Fedora Update System 2020-09-03 14:40:55 UTC
FEDORA-2020-ce7cc4dfc4 has been submitted as an update to Fedora 33. https://bodhi.fedoraproject.org/updates/FEDORA-2020-ce7cc4dfc4

Comment 7 Fedora Update System 2020-09-03 18:08:53 UTC
FEDORA-2020-ce7cc4dfc4 has been pushed to the Fedora 33 testing repository.
In short time you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --advisory=FEDORA-2020-ce7cc4dfc4 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2020-ce7cc4dfc4

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 8 Fedora Update System 2020-09-25 16:42:15 UTC
FEDORA-2020-ce7cc4dfc4 has been pushed to the Fedora 33 stable repository.
If problem still persists, 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.