buildozer 1.0.0 → 1.0.1

data/CHANGELOG.md

@@ -1,3 +1,13 @@
-# 1.0.0 (unreleased)
+# 1.0.2 (unreleased)
 
-* Initial commit
+# 1.0.1 (March 26th, 2013)
+
+* Added architecture field in package DSL
+* Added option flag `-n, --dry-run` to RPM command
+  This will show the command that would be executed without executing them.
+
+# 1.0.0 (February 20th, 2013)
+
+* RPM command implementation
+* Package DSL implementation
+* Definition DSL implementation

data/README.md

@@ -13,10 +13,137 @@ Use this command to install buildozer:
 
     gem install buildozer
 
+## Versioning
+
+A small note about versioning of this project. Backward compatibility
+for users will be kept for major version. That means that your definition
+files are guaranteed to work for version `1.y.z`. The day we release
+`2.y.z`, it will not be backward compatible with major version lower
+than 2.
+
+Internal representation will be backward compatible for minor version.
+That means that if your are using buildozer as a library, you can follow
+`x.1.z` whitout fear of breaking your code. However, changing from `x.1.z`
+to `x.2.z` will likely requires changes on your part.
+
+Finally, new additions and changes that are backward compatible for users
+and developers will be made on the revision version. For example, `x.y.3`
+will be compatible with `x.y.4`.
+
 ## Usage
 
-Coming soon ...
+The meats that feeds every buildozer command is the definition. The
+definition file (always ending with `.bd.rb`) is defined using a custom
+DSL based on ruby that ease packages definition. Each definition can
+contains `0` to `N` packages.
+
+For each package, you defined some basic information about it like
+the name of the package, it's version, the url where sources can be found
+and many others including what the package provides and its dependencies.
+
+For now, each definition if more or less platform specific but I hope
+this will change overtime to have platform agnostic package definition.
+
+Here a sample build definition for `erlang` (Important note, the build
+definition is fake for now, will update it with real stuff at some
+points):
+
+```ruby
+# Buildozer package definition
+#  Architecture: x86
+#  Platform: CentOS 5.9
+
+package "erlang" do
+  url "http://www.erlang.org/download/otp_src_R15B03-1.tar.gz"
+  version "R15B03"
+  maintainer "Matthieu Vachon"
+
+  architecture "i686"
+
+  provides "erlang"
+
+  depends "libc.so6"
+
+  includes "usr/bin"
+end
+
+package "erlang-devel" do
+  url "http://www.erlang.org/download/otp_src_R15B03-1.tar.gz"
+  version "R15B03"
+  maintainer "Matthieu Vachon"
+
+  architecture "i686"
+
+  provides "erlang-devel"
+
+  depends "libc.so6"
+
+  includes "usr/include"
+end
+```
+
+A definition can contain multiple package definition. This is useful
+to define at the same time normal package and a development package.
+In the future, we plan to reduce duplication of package information
+maybe be specifying a inheritance mechanisms, ideas are welcome :)
+
+Here the list of valid options for a package
+
+ * `url` -
+   The url where the package can be downloaded.
+
+ * `version` -
+   The current version of the package
+
+ * `maintainer` (optional) -
+   The name of the maintainer of this package. This is NOT the author but
+   rather the one who build the package.
+
+ * `architecture` (optional) -
+   The target architecture of the package. If left blank, the architecture of
+   the machine is used. If set, it must be `:auto` or a non-empty string value.
+
+ * `provides` -
+   An artifact that the package provides. Usually, this is binaries and
+   libraries generated by the package when built. This can be call multiple
+   times, each time adding a new provided artifact.
+
+ * `depends` -
+   An artifact that the package depends on. Usually, this will be some libraries
+   or binaries needed to run the package. This can be call multiple
+   times, each time adding a new dependency artifact.
+
+ * `includes` -
+   A list of folders that will be packaged when building an archive for the package
+   like a rpm. This can be call multiple times, each time adding a new included
+   folder.
+
+### Commands
+
+When you have a build definition, let's call it `erlang.bd.rb`, you pass it to
+the various commands to do something useful with it.
+
+#### Command RPM
+
+The command rpm can be used to generate rpms from a definition file. The command
+will produce a single rpm for each package defined in the definition file.
+
+    > buildozer rpm -d "/path/to/built/package" erlang.bd.rb
+
+It is important to note that you will need `rpm_build` on your machine for this
+to work. The command will fail if it's not the case.
+
+In its internals, buildozer uses `fpm` to produce the rpm archive file. You can
+see the commands that would be executed by doing a dry-run. This will print
+the commands to the standard ouput instead of executing them.
+
+    > buildozer rpm -n -d "/path/to/built/package" erlang.bd.rb
 
 ## Contributing & Support
 
-There is no direct way to contribute right now.
+To contribute, simply fork the repository, make the changes you want and submit
+a pull request. Also, you can start an issue without a pull request if you would
+like some features or you have found some bugs.
+
+You can also creates an issue just to discuss potential ideas and future directions
+for the project.

data/bin/buildozer

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-
 require 'buildozer/cli/buildozer'
 
 Buildozer::Cli::Buildozer.start()

data/lib/buildozer/builder/rpm.rb

@@ -15,6 +15,10 @@ module Buildozer
         system(command())
       end
 
+      def show()
+        puts(command())
+      end
+
       def command()
         buffer = StringIO.new
 
@@ -26,6 +30,10 @@ module Buildozer
 
         buffer << " -m \"#{@package.maintainer}\"" if @package.maintainer
 
+        if @package.architecture and not @package.architecture == :auto
+          buffer << " -a \"#{@package.architecture}\""
+        end
+
         @package.provides.each do |provide|
           buffer << " --provides \"#{provide}\""
         end
@@ -47,7 +55,7 @@ module Buildozer
 
       def validate()
         if @package.includes.empty?()
-          raise Builder::InvalidRpmPackage, "Invalid rpm package, must have at least on 'includes'"
+          raise Builder::InvalidRpmPackage, "Invalid rpm package, must have at least one 'includes'"
         end
       end
     end

data/lib/buildozer/cli/buildozer.rb

@@ -6,14 +6,17 @@ module Buildozer
   module Cli
     class Buildozer < Thor
 
-      desc "rpm FILE", "Build a rpm package using fpm"
-      method_option :dir, :aliases => "-d", :default => ".", :desc => "Directory where package files are located"
-      def rpm(file)
-        definition = Dsl.compile(file)
+      desc "rpm DEFINITION_FILE", "Build a rpm package using fpm"
+      method_option :dir, :aliases => "-d", :default => ".", :type => :string, :desc => "Directory where package files are located"
+      method_option :"dry-run", :aliases => "-n", :default => false, :type => :boolean, :desc => "Only show commands that would be exectued without actually running them"
+      def rpm(definition_file)
+        definition = Dsl.compile(definition_file)
 
         definition.packages.each do |package|
           builder = Builder::Rpm.new(package, File.expand_path(options[:dir]))
-          puts builder.build()
+
+          builder.build() if not options[:"dry-run"]
+          builder.show() if options[:"dry-run"]
         end
       end
     end

data/lib/buildozer/dsl/compiler.rb

@@ -12,6 +12,11 @@ module Buildozer
         send("compile_#{fragment.type()}", fragment)
       end
 
+      ##
+      # Function that receives a dsl definition and compile
+      # it to a model definition. This compilation is done
+      # mainly to report user-friendly error when dsl
+      # definition is invalid
       def self.compile_definition(definition)
         Validator.validate_definition(definition);
 
@@ -21,6 +26,11 @@ module Buildozer
         })
       end
 
+      ##
+      # Function that receives a dsl package and compile
+      # it to a model package. This compilation is done
+      # mainly to report user-friendly error when dsl
+      # package is invalid
       def self.compile_package(package)
         Validator.validate_package(package);
 

data/lib/buildozer/dsl/compiler/validator.rb

@@ -45,6 +45,20 @@ module Buildozer
           if not options.has_key?(:url)
             raise InvalidDslPackage, "Invalid package, must have an 'url'"
           end
+
+          if options.has_key?(:architecture)
+            architecture = options[:architecture]
+
+            validate_architecture(architecture)
+          end
+        end
+
+        def self.validate_architecture(architecture)
+          if architecture == :auto or (architecture.kind_of?(String) and not architecture == "")
+            return
+          end
+
+          raise InvalidDslPackage, "Invalid package, architecture must be :auto or a non-empty String, currently [#{architecture}]"
         end
       end
     end

data/lib/buildozer/dsl/package.rb

@@ -5,6 +5,9 @@ module Buildozer
     class Package < Fragment
       def initialize(name, &block)
         @name = name
+
+        @architecture = :auto
+
         @provides = []
         @depends = []
         @includes = []
@@ -30,6 +33,10 @@ module Buildozer
         @maintainer = maintainer
       end
 
+      def architecture(architecture)
+        @architecture = architecture
+      end
+
       def depends(package)
         @depends << package
       end

data/lib/buildozer/model/package.rb

@@ -2,7 +2,7 @@ module Buildozer
   module Model
     class Package
       attr_accessor :name, :version, :revision, :archive, :url,
-                    :maintainer,
+                    :maintainer, :architecture,
                     :provides, :depends,
                     :includes
 
@@ -13,6 +13,8 @@ module Buildozer
         @archive = options.fetch(:archive, "#{@name}-#{@version}")
         @url = options.fetch(:url)
 
+        @architecture = options.fetch(:architecture, :auto)
+
         @maintainer = options.fetch(:maintainer, nil)
 
         @provides = options.fetch(:provides, [])

data/lib/buildozer/version.rb

@@ -1,3 +1,3 @@
 module Buildozer
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/test/lib/buildozer/builder/test_rpm.rb

@@ -20,18 +20,39 @@ module Buildozer
         Model::Package.new(@defaults.merge(options))
       end
 
+      def test_command_without_architecture()
+        package = base_package()
+        command = Builder::Rpm.new(package, ".").command()
+
+        assert(command !~ /-a/, "Architecture flag [-a] should NOT be present in #{command}")
+      end
+
+      def test_command_with_architecture()
+        package = base_package({:architecture => "i989"})
+        command = Builder::Rpm.new(package, ".").command()
+
+        assert(command =~ /-a "i989"/, "Architecture flag [-a i989] should be present in #{command}")
+      end
+
+      def test_command_with_architecture_auto()
+        package = base_package({:architecture => :auto})
+        command = Builder::Rpm.new(package, ".").command()
+
+        assert(command !~ /-a/, "Architecture flag [-a] should NOT be present in #{command}")
+      end
+
       def test_command_without_maintainer()
         package = base_package()
         command = Builder::Rpm.new(package, ".").command()
 
-        assert(command !~ /-m/)
+        assert(command !~ /-m/, "Maintainer flag [-m] should NOT be present in #{command}")
       end
 
       def test_command_with_maintainer()
         package = base_package({:maintainer => "Joe Armstrong"})
         command = Builder::Rpm.new(package, ".").command()
 
-        assert(command =~ /-m "Joe Armstrong"/)
+        assert(command =~ /-m "Joe Armstrong"/, "Maintainer flag [-m Joe Armstrong] should be present in #{command}")
       end
 
       def test_package_no_includes()

data/test/lib/buildozer/dsl/test_compiler.rb

@@ -26,6 +26,7 @@ module Buildozer
         assert_equal("http://www.erlang.org/download/otp_src_R15B03-1.tar.gz", package.url)
         assert_equal("R15B03", package.version)
         assert_equal("erlang-R15B03", package.archive)
+        assert_equal("i989", package.architecture)
         assert_equal("Nu Echo (Matthieu Vachon)", package.maintainer)
       end
 
@@ -53,6 +54,21 @@ module Buildozer
 
         assert_equal([], package.includes)
       end
+
+      def test_architecture_auto()
+        definition = compile("definition_architecture_auto.bd.rb")
+        packages = definition.packages
+        assert_equal(1, packages.size())
+
+        package = packages[0]
+        assert_equal(:auto, package.architecture)
+      end
+
+      def test_invalid_architecture()
+        assert_raise(Compiler::InvalidDslPackage) do
+          compile("definition_invalid_architecture.bd.rb")
+        end
+      end
     end
 
     class FakeFragment < Fragment

data/test/resources/definition_architecture_auto.bd.rb

@@ -0,0 +1,12 @@
+
+package "erlang" do
+  url "http://www.erlang.org/download/otp_src_R15B03-1.tar.gz"
+  version "R15B03"
+  maintainer "Nu Echo (Matthieu Vachon)"
+
+  architecture :auto
+
+  provides "erlang"
+
+  depends "libc.so6"
+end

data/test/resources/definition_full.bd.rb

@@ -1,9 +1,14 @@
+# Buildozer package definition for Erlang
+#  Architecture: x86
+#  Platform: CentOS 5.9
 
 package "erlang" do
   url "http://www.erlang.org/download/otp_src_R15B03-1.tar.gz"
   version "R15B03"
   maintainer "Nu Echo (Matthieu Vachon)"
 
+  architecture "i989"
+
   provides "erlang"
 
   depends "libc.so6"

data/test/resources/definition_invalid_architecture.bd.rb

@@ -0,0 +1,11 @@
+
+package "erlang" do
+  url "http://www.erlang.org/download/otp_src_R15B03-1.tar.gz"
+  version "R15B03"
+  maintainer "Nu Echo (Matthieu Vachon)"
+  architecture 15
+
+  provides "erlang"
+
+  depends "libc.so6"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildozer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-21 00:00:00.000000000 Z
+date: 2013-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fpm
@@ -97,7 +97,9 @@ files:
 - lib/buildozer/version.rb
 - test/lib/buildozer/builder/test_rpm.rb
 - test/lib/buildozer/dsl/test_compiler.rb
+- test/resources/definition_architecture_auto.bd.rb
 - test/resources/definition_full.bd.rb
+- test/resources/definition_invalid_architecture.bd.rb
 - test/resources/definition_no_includes.bd.rb
 homepage: https://github.com/maoueh/buildozer
 licenses: []
@@ -111,18 +113,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 181030610370950058
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 181030610370950058
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -132,5 +128,7 @@ summary: Application to build and package software.
 test_files:
 - test/lib/buildozer/builder/test_rpm.rb
 - test/lib/buildozer/dsl/test_compiler.rb
+- test/resources/definition_architecture_auto.bd.rb
 - test/resources/definition_full.bd.rb
+- test/resources/definition_invalid_architecture.bd.rb
 - test/resources/definition_no_includes.bd.rb