Merge pull request #332 from antonini/master

Implemented the changelog to RPM

Author: muuki88

src/main/scala/com/typesafe/sbt/packager/rpm/Keys.scala

@@ -14,6 +14,9 @@ trait RpmKeys {
   val rpmPrefix = SettingKey[Option[String]]("rpm-prefix", "File system prefix for relocatable package.")
   val rpmMetadata = SettingKey[RpmMetadata]("rpm-metadata", "Metadata associated with the generated RPM.")
 
+  // Changelog
+  val rpmChangelogFile = SettingKey[Option[String]]("rpm-changelog-file", "RPM changelog file to be imported")
+
   // DESCRIPTION KEYS
   // TODO - Summary and license are required.
   val rpmLicense = SettingKey[Option[String]]("rpm-license", "License of the code within the RPM.")

src/main/scala/com/typesafe/sbt/packager/rpm/RpmMetadata.scala

@@ -5,6 +5,7 @@ package rpm
 import linux.{ LinuxPackageMapping, LinuxFileMetaData }
 import sbt._
 import com.typesafe.sbt.packager.linux.LinuxSymlink
+import java.io.File
 
 case class RpmMetadata(
   name: String,
@@ -29,7 +30,8 @@ case class RpmDescription(
   url: Option[String] = None,
   group: Option[String] = None,
   packager: Option[String] = None,
-  icon: Option[String] = None)
+  icon: Option[String] = None,
+  changelogFile: Option[String] = None)
 
 case class RpmDependencies(
   provides: Seq[String] = Seq.empty,
@@ -204,8 +206,15 @@ case class RpmSpec(meta: RpmMetadata,
     // Write file mappings
     sb append fileSection
     // TODO - Write triggers...
-    // TODO - Write changelog...
-
+    desc.changelogFile foreach { changelog =>
+      val tmpFile = new File(changelog)
+      if (tmpFile.isFile() && tmpFile.exists()) {
+        // if (Files.exists(Paths.get(changelog))) {
+        val content = scala.io.Source.fromFile(changelog).mkString
+        sb append "%changelog\n"
+        sb append ("%s\n" format content)
+      }
+    }
     sb.toString
   }
 }

src/main/scala/com/typesafe/sbt/packager/rpm/RpmPlugin.scala

@@ -39,6 +39,7 @@ trait RpmPlugin extends Plugin with LinuxPlugin {
     rpmPosttrans := None,
     rpmPreun := None,
     rpmPostun := None,
+    rpmChangelogFile := None,
     rpmBrpJavaRepackJars := false,
     rpmScriptsDirectory <<= sourceDirectory apply (_ / "rpm" / Names.Scriptlets),
     // Explicitly defer  default settings to generic Linux Settings.
@@ -53,7 +54,7 @@ trait RpmPlugin extends Plugin with LinuxPlugin {
       rpmMetadata <<=
         (packageName, version, rpmRelease, rpmPrefix, packageArchitecture, rpmVendor, rpmOs, packageSummary, packageDescription, rpmAutoprov, rpmAutoreq) apply RpmMetadata,
       rpmDescription <<=
-        (rpmLicense, rpmDistribution, rpmUrl, rpmGroup, rpmPackager, rpmIcon) apply RpmDescription,
+        (rpmLicense, rpmDistribution, rpmUrl, rpmGroup, rpmPackager, rpmIcon, rpmChangelogFile) apply RpmDescription,
       rpmDependencies <<=
         (rpmProvides, rpmRequirements, rpmPrerequisites, rpmObsoletes, rpmConflicts) apply RpmDependencies,
       rpmPre <<= (rpmPre, rpmBrpJavaRepackJars) apply {

src/sbt-test/rpm/changelog-test/build.sbt

@@ -0,0 +1,33 @@
+import NativePackagerKeys._
+
+packageArchetype.java_server
+
+name := "rpm-test"
+
+version := "0.1.0"
+
+maintainer := "Endrigo Antonini <[email protected]>"
+
+packageSummary := "Test rpm package with changelog"
+
+packageDescription := """A fun package description of our software,
+  with multiple lines."""
+
+rpmRelease := "1"
+
+rpmVendor := "eidoscode"
+
+rpmUrl := Some("http://github.com/sbt/sbt-native-packager")
+
+rpmLicense := Some("BSD")
+
+rpmChangelogFile := Some("conf/changelog")
+
+TaskKey[Unit]("check-spec-file") <<= (target, streams) map { (target, out) =>
+  val spec = IO.read(target / "rpm" / "SPECS" / "rpm-test.spec")
+  // Check if the RPM writted the changelog tag on the task
+  assert(spec contains "%changelog\n", "Spec doesn't contain %changelog tag on the SPEC")
+  out.log.success("Successfully tested rpm test file")
+  ()
+}
+

src/sbt-test/rpm/changelog-test/conf/changelog

@@ -0,0 +1,9 @@
+* Sun Aug 24 2014 Team <[email protected]> - 1.1.0
+-Allow to login using social networks
+* Wed Aug 20 2014 Team <[email protected]> - 1.0.1
+-Vulnerability fix.
+-Other information.
+-Feature list.
+* Tue Aug 19 2014 Team <[email protected]> - 1.0.0
+-First version of the system
+

src/sbt-test/rpm/changelog-test/project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % sys.props("project.version"))

src/sbt-test/rpm/changelog-test/test

@@ -0,0 +1,9 @@
+# Run the debian packaging.
+> rpm:package-bin
+$ exists target/rpm/RPMS/noarch/rpm-test-0.1.0-1.noarch.rpm
+$ exists target/rpm/SPECS/rpm-test.spec
+
+# Check files for defaults
+> check-spec-file
+> set NativePackagerKeys.rpmBrpJavaRepackJars := true
+> check-spec-file

src/sphinx/DetailedTopics/redhat.rst

@@ -16,6 +16,7 @@ Rpms require the following specific settings:
     rpmVendor := "typesafe",
     rpmUrl := Some("http://github.com/paulp/sbt-extras"),
     rpmLicense := Some("BSD"),
+    rpmChangelogFile := Some("changelog")
 
 
 Informational Settings
@@ -63,6 +64,9 @@ Meta Settings
     ``rpmPrefix``
     The path passed set as the base for the revocable package
 
+    ``rpmChangelogFile``
+    External file to be imported and used to generate the changelog of the RPM.
+
 
 Scriptlet Settings
 ~~~~~~~~~~~~~~~~~~
@@ -119,6 +123,28 @@ Example Settings
     defaultLinuxLogsLocation := defaultLinuxInstallLocation + "/" + name
   
 
+rpmChangelogFile
+----------
+The rpmChangelogFile property allows you to set a source that will be imported and used on the RPM generation. So if you use rpm commands to see the changelog it brings that information. You have to create the content on that file following the RPM conventions that are available here http://fedoraproject.org/wiki/Packaging:Guidelines#Changelogs.
+
+Example Settings
+~~~~~~~~~~~~~~~~~~
+
+.. code-block:: scala
+
+    changelog := "changelog.txt",
+    rpmChangelogFile := Some(changelog)
+
+
+.. code-block:: txt
+    * Sun Aug 24 2014 Team <[email protected]> - 1.1.0
+    -Allow to login using social networks
+    * Wed Aug 20 2014 Team <[email protected]> - 1.0.1
+    -Vulnerability fix.
+    * Tue Aug 19 2014 Team <[email protected]> - 1.0.0
+    -First version of the system
+
+
 Template Changes
 ~~~~~~~~~~~~~~~~~~
 Apply the following changes to the default init start script.  You can find this in the sbt-native-packager source.

test-project/build.sbt

@@ -29,6 +29,8 @@ rpmVendor := "typesafe"
 
 rpmLicense := Some("BSD")
 
+rpmChangelogFile := Some("changelog.txt")
+
 //debianMakePrermScript := Some(sourceDirectory.value / "deb" / "control" / "prerm") //change defaults
 
 

test-project/changelog.txt

@@ -0,0 +1,9 @@
+* Sun Aug 24 2014 Team <[email protected]> - 1.1.0
+-Allow to login using social networks
+* Wed Aug 20 2014 Team <[email protected]> - 1.0.1
+-Vulnerability fix.
+-Other information.
+-Feature list.
+* Tue Aug 19 2014 Team <[email protected]> - 1.0.0
+-First version of the system
+