Bug 1207946 - Review Request: javawriter - A Java API for generating .java source files
Summary: Review Request: javawriter - A Java API for generating .java source files
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Raphael Groner
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: 1207948
TreeView+ depends on / blocked
 
Reported: 2015-04-01 04:23 UTC by gil cattaneo
Modified: 2015-04-21 18:37 UTC (History)
2 users (show)

Fixed In Version: javawriter-2.5.1-1.fc22
Clone Of:
Environment:
Last Closed: 2015-04-21 18:37:41 UTC
Type: ---
Embargoed:
projects.rg: fedora-review+
puiterwijk: fedora-cvs+


Attachments (Terms of Use)

Description gil cattaneo 2015-04-01 04:23:50 UTC
Spec URL: https://gil.fedorapeople.org/javawriter.spec
SRPM URL: https://gil.fedorapeople.org/javawriter-2.5.1-1.fc20.src.rpm
Description: A utility class which aids in generating Java source files.
Fedora Account System Username: gil

Task info: http://koji.fedoraproject.org/koji/taskinfo?taskID=9390035

Comment 1 Raphael Groner 2015-04-04 19:41:31 UTC
Taken. :)

Comment 2 gil cattaneo 2015-04-04 20:57:52 UTC
Spec URL: https://gil.fedorapeople.org/javapoet.spec
SRPM URL: https://gil.fedorapeople.org/javapoet-2.5.1-1.fc20.src.rpm

renamed, cause: newer unreleased com.squareup.dagger:dagger-compiler use com.squareup:javapoet and for simplified future upgrading

Comment 3 gil cattaneo 2015-04-04 22:02:41 UTC
Spec URL: https://gil.fedorapeople.org/javawriter.spec
SRPM URL: https://gil.fedorapeople.org/javawriter-2.5.1-1.fc20.src.rpm

- revert previous changes

Comment 4 Raphael Groner 2015-04-05 13:11:00 UTC
APPROVED

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

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


Issues:
=======
- 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 %doc.
  Note: Cannot find LICENSE.txt in rpm(s)
  See:
  http://fedoraproject.org/wiki/Packaging/LicensingGuidelines#License_Text

==> OK cause of %license LICENSE.txt, but warning that this will not work for EPEL and Fedora 20!

- Are you really sure to rename this package in Fedora to javawriter in contrast to the upstream name javapoet? How can it be found with the classic name as guessed from upstream? Okay, I can see the recent github releases are named javawriter. Maybe we should use the younger fork of google.

> Square's Javawriter
> This is a fork of Square's Javapoet intended as a staging ground for changes
> originating from inside google. While it may vary from Square's, the intention 
> is that all changes end up merged into to Square's repository, and that this
> fork will only vary temporarily while change is in process. Generally, unless 
> you are depending on features not yet merged you should depend on square's 
> version. We have no plans to do releases, though this fork will publish 
> snapshots on successful merges.
https://github.com/google/javapoet/blob/master/README.md

- Include also %doc CONTRIBUTING.md into %files cause this file tells to sign a special contract about copyright etc. to be allowed for contribution at upstream.

===== 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.
[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 /home/builder/fedora-
     review/1207946-javawriter/licensecheck.txt

==> OK. But two files without embedded license text, maybe report that as an upstream issue.
==> The javadoc script is not redistributed and other is test stuff.

[x]: License file installed when any subpackage combination is installed.
[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).
[?]: Package is named according to the Package Naming Guidelines.

==> Please try to confirm with upstream to use the fork name, see my comment above.

[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.
[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 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: No rpmlint messages.
[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]: 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 do not use a name that already exist
[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

Java:
[x]: Bundled jar/class files should be removed before build
[x]: Packages have proper BuildRequires/Requires on jpackage-utils
     Note: Maven packages do not need to (Build)Require jpackage-utils. It is
     pulled in by maven-local
[x]: Javadoc documentation files are generated and included in -javadoc
     subpackage
[x]: Javadoc subpackages should not have Requires: jpackage-utils
[x]: Javadocs are placed in %{_javadocdir}/%{name} (no -%{version} symlink)

Maven:
[?]: If package contains pom.xml files install it (including depmaps) even
     when building with ant

==> Can not check magical maven logic.

[x]: POM files have correct Maven mapping
[x]: Maven packages should use new style packaging
[x]: Old add_to_maven_depmap macro is not being used
[x]: Packages DO NOT have Requires(post) and Requires(postun) on jpackage-
     utils for %update_maven_depmap macro
[x]: Package DOES NOT use %update_maven_depmap in %post/%postun
[x]: Packages use %{_mavenpomdir} instead of %{_datadir}/maven2/poms

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

Generic:
[x]: 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]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in javawriter-
     javadoc

==> javadoc is a documentation package and therefore fully optional and independent

[?]: 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.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[?]: %check is present and all tests pass.

==> Could those test/**/*Test.java files be used to run a short test? Why is it broken?
> # Unavailable test deps: org.easytesting:fest-assert-core:2.0M8

[x]: Packages should try to preserve timestamps of original installed files.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: Sources can be downloaded from URI in Source: tag
[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]: Dist tag is present (not strictly required in GL).
[x]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: SourceX is a working URL.
[x]: Spec use %global instead of %define unless justified.

Java:
[x]: Package uses upstream build method (ant/maven/etc.)
[x]: Packages are noarch unless they use JNI

===== 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: javawriter-2.5.1-1.fc23.noarch.rpm
          javawriter-javadoc-2.5.1-1.fc23.noarch.rpm
          javawriter-2.5.1-1.fc23.src.rpm
3 packages and 0 specfiles checked; 0 errors, 0 warnings.




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


Requires
--------
javawriter-javadoc (rpmlib, GLIBC filtered):
    jpackage-utils

javawriter (rpmlib, GLIBC filtered):
    java-headless
    jpackage-utils



Provides
--------
javawriter-javadoc:
    javawriter-javadoc

javawriter:
    javawriter
    mvn(com.squareup:javawriter)
    mvn(com.squareup:javawriter:pom:)



Source checksums
----------------
https://github.com/square/javapoet/archive/javawriter-2.5.1.tar.gz :
  CHECKSUM(SHA256) this package     : 2d13ec301040b62c9de29f349aabc1ca115a364c6c04c36836fc285375ba7528
  CHECKSUM(SHA256) upstream package : 2d13ec301040b62c9de29f349aabc1ca115a364c6c04c36836fc285375ba7528


Generated by fedora-review 0.5.2 (63c24cb) last change: 2014-07-14
Command line :/usr/bin/fedora-review -v -m fedora-rawhide-x86_64 -o=--yum --clean --init -b 1207946
Buildroot used: fedora-rawhide-x86_64
Active plugins: Generic, Shell-api, Java
Disabled plugins: C/C++, Python, fonts, SugarActivity, Ocaml, Perl, Haskell, R, PHP, Ruby
Disabled flags: EXARCH, EPEL5, BATCH, DISTTAG

Comment 5 gil cattaneo 2015-04-05 14:53:36 UTC
(In reply to Raphael Groner from comment #4)

> 
> - Are you really sure to rename this package in Fedora to javawriter in
> contrast to the upstream name javapoet? How can it be found with the classic
> name as guessed from upstream? Okay, I can see the recent github releases
> are named javawriter. Maybe we should use the younger fork of google.

> [?]: Package is named according to the Package Naming Guidelines.
> 

the library was originally appointed javawriter and recently has been renamed javapoet. the two libraries are incompatible. the fork of google dagger (https://github.com/google/dagger) uses as you said their fork javawriter ... for me ... a crap ... until i prefer to use the original (Square) release
for me there aren't contrast with upstream

> > Square's Javawriter
> > This is a fork of Square's Javapoet intended as a staging ground for changes
> > originating from inside google. While it may vary from Square's, the intention 
> > is that all changes end up merged into to Square's repository, and that this
> > fork will only vary temporarily while change is in process. Generally, unless 
> > you are depending on features not yet merged you should depend on square's 
> > version. We have no plans to do releases, though this fork will publish 
> > snapshots on successful merges.
> https://github.com/google/javapoet/blob/master/README.md
For now i prefer use the Square library and not have 

> - Include also %doc CONTRIBUTING.md into %files cause this file tells to
> sign a special contract about copyright etc. to be allowed for contribution
> at upstream.

Done

> Maven:
> [?]: If package contains pom.xml files install it (including depmaps) even
>      when building with ant
> 
> ==> Can not check magical maven logic.

listed in .mfiles*

> [?]: %check is present and all tests pass.
> 
> ==> Could those test/**/*Test.java files be used to run a short test? Why is
> it broken?
The all test suite use fest-assert-core:2.0M8 and i tried to remove some files but at the end not have one valid *Test.java file for this scope
> > # Unavailable test deps: org.easytesting:fest-assert-core:2.0M8

Comment 6 gil cattaneo 2015-04-05 15:01:12 UTC
Thanks!

New Package SCM Request
=======================
Package Name: javawriter
Short Description: A Java API for generating .java source files
Upstream URL: https://github.com/square/javapoet
Owners: gil
Branches: f22
InitialCC: java-sig

Comment 7 Patrick Uiterwijk 2015-04-06 09:44:07 UTC
Git done (by process-git-requests).

Comment 8 Fedora Update System 2015-04-06 11:18:04 UTC
javawriter-2.5.1-1.fc22 has been submitted as an update for Fedora 22.
https://admin.fedoraproject.org/updates/javawriter-2.5.1-1.fc22

Comment 9 Fedora Update System 2015-04-06 17:40:11 UTC
javawriter-2.5.1-1.fc22 has been pushed to the Fedora 22 testing repository.

Comment 10 Fedora Update System 2015-04-21 18:37:41 UTC
javawriter-2.5.1-1.fc22 has been pushed to the Fedora 22 stable repository.


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