albacore 2.0.0.rc.13 → 2.0.0.rc.14

data/README.md

@@ -337,6 +337,19 @@ filesystem:
     + Files not in src/MyMvcSite/MyMvcSite.csproj but on filesystem:
       file_missing_in_csproj.png
 
+## Writing Code
+
+ 1. Add a rspec spec in specs/
+ 1. Run `bundle exec rspec spec` to verify test fails
+ 1. Implement feature you want
+ 1. Run the tests again, have them pass
+ 1. Make a PR from your feature branch against `master`
+
+Document your code with
+[YARD](http://rubydoc.info/gems/yard/file/docs/GettingStarted.md) as you're
+writing it: it's much easier to write the documentation together with the code
+than afterwards.
+
 ## Docs: Zippy
 
 This is a simple example which uses rubyzip to recursively generate a zip file

data/lib/albacore/app_spec.rb

@@ -0,0 +1,176 @@
+require 'yaml'
+require 'albacore/logging'
+require 'xsemver'
+
+module Albacore
+  # a spec object
+  class AppSpec
+    include ::Albacore::Logging
+
+    # Create a new app spec from yaml data; will use heuristics to let the
+    # developer avoid as much typing and definition mongering as possible; for
+    # details see the unit tests and the documentation for this class.
+    #
+    # @descriptor_path [String] The location of the descriptor file (the .appspec)
+    # @data [String] A yaml-containing string
+    # @semver [::XSemVer] An optional semver instance that can be queried for what
+    #   version the package has.
+    def initialize descriptor_path, data, semver = nil
+      raise ArgumentError, 'data is nil' unless data
+      @path = descriptor_path
+      @conf = YAML.load(data) || Hash.new
+
+      project_path = resolve_project descriptor_path, @conf
+      raise ArgumentError, "couldn't find project, descriptor_path: #{descriptor_path.inspect}" unless valid_path project_path
+
+      @proj = Project.new project_path
+      @semver = semver
+    end
+
+    # Resolves the project file given an optional descriptor path or a
+    # configuration hash or both. One of the other of the parameters need to
+    # exist, or an error will be thrown.
+    #
+    # @param descriptor_path May be nil
+    # @param conf [#[]] A hash or something indexable
+    def resolve_project descriptor_path, conf
+      trace { "trying to resolve project, descriptor_path: #{descriptor_path.inspect}, conf: #{conf.inspect} [AppSpec#resolve_path]" }
+
+      project_path = conf['project_path']
+      return File.join File.dirname(descriptor_path), project_path if project_path and valid_path descriptor_path
+
+      trace { 'didn\'t have both a project_path and a descriptor_path that was valid [AppSpec#resolve_project]' }
+      return project_path if project_path
+      find_first_project descriptor_path
+    end
+
+    # Given a descriptor path, tries to find the first matching project file. If
+    # you have multiple project files, the order of which {Dir#glob} returns
+    # values will determine which is chosen
+    def find_first_project descriptor_path
+      trace { "didn't have a valid project_path, trying to find first project at #{descriptor_path.inspect}" }
+      dir = File.dirname descriptor_path
+      abs_dir = File.expand_path dir
+      Dir.glob(File.join(abs_dir, '*proj')).first
+    end
+
+    # path of the *.appspec
+    attr_reader :path
+
+    # the loaded configuration in that appspec
+    attr_reader :conf
+
+    # the project the spec applies to
+    attr_reader :proj
+
+    # gets the fully qualified path of the directory where the appspec file is
+    def dir_path
+      File.expand_path(File.dirname(@path))
+    end
+
+    # title for puppet, title for app, title for process running on server
+    def title
+      t = conf['title'] || proj.title
+      t.downcase
+    end
+
+    # the description that is used when installing and reading about the package in the
+    # package manager
+    def description
+      conf['description'] || proj.description
+    end
+
+    # gets the uri source of the project
+    def uri
+      conf['uri'] || git_source
+    end
+
+    # gets the category this package is in, both for the RPM and for puppet and
+    # for possibly assigning to a work-stealing cluster or to start the app in
+    # the correct node-cluster if you have that implemented
+    def category
+      conf['category'] || 'apps'
+    end
+
+    # gets the license that the app is licensed under
+    def license
+      conf['license'] || proj.license
+    end
+
+    # gets the version with the following priorities:
+    #  - semver version passed in c'tor
+    #  - ENV['BUILD_VERSION']
+    #  - .appspec's version
+    #  - .xxproj's version
+    #  - semver from disk
+    #  - if all above fails; use '1.0.0'
+    def version
+      semver_version || ENV['BUILD_VERSION'] || conf['version'] || proj.version || semver_disk_version || '1.0.0'
+    end
+
+    # gets the binary folder, first from .appspec then from proj given a configuration
+    # mode (default: Release)
+    def bin_folder configuration = 'Release'
+      conf['bin'] || proj.output_path(configuration)
+    end
+
+    # gets the folder that is used to keep configuration that defaults
+    # to the current (.) directory
+    def conf_folder
+      conf['conf_folder'] || '.'
+    end
+
+    # gets an enumerable list of paths that are the 'main' contents of the package
+    #
+    def contents
+      conf['contents'] || []
+    end
+
+    # TODO: support a few of these: https://github.com/bernd/fpm-cookery/wiki/Recipe-Specification
+
+    # load the App Spec from a descriptor path
+    def self.load descriptor_path
+      raise ArgumentError, 'missing parameter descriptor_path' unless descriptor_path
+      raise ArgumentError, 'descriptor_path does not exist' unless File.exists? descriptor_path
+      AppSpec.new(descriptor_path, File.read(descriptor_path))
+    end
+
+    # Customizing the to_s implementation to make the spec more amenable for printing
+    def to_s
+      "AppSpec[#{title}], #{@conf.keys.length} keys]"
+    end
+
+    private
+    # determines whether the passed path is valid and existing
+    def valid_path path
+      path and File.exists? path
+    end
+
+    # gets the source from the current git repository: finds the first remote and uses
+    # that as the source of the RPM
+    def git_source
+      `git remote -v`.
+        split(/\n/).
+        map(&:chomp).
+        map { |s| s.split(/\t/)[1].split(/ /)[0] }.
+        first
+    end
+
+    # Gets the semver version in %M.%m.%p form or nil if a semver isn't given
+    # in the c'tor of this class. If we have gotten an explicit version in the constructor,
+    # let's assume that version should be used in front of anything else and that the calling
+    # libraries know what they are doing.
+    def semver_version
+      return @semver.format '%M.%m.%p' if @semver
+      nil
+    end
+
+    # if everything else fails, return the semver from disk
+    def semver_disk_version
+      v = XSemVer::SemVer.find
+      v.format '%M.%m.%p' if v
+    rescue SemVerMissingError
+      nil
+    end
+  end
+end

data/lib/albacore/dsl.rb

@@ -20,6 +20,7 @@ module Albacore
     end
 
     def asmver_files *args, &block
+      require 'albacore/task_types/asmver'
       Albacore.define_task *args do
         c = Albacore::Asmver::MultipleFilesConfig.new
         yield c
@@ -93,6 +94,16 @@ module Albacore
         t.execute
       end
     end
+
+    # Generate .rpm or .deb files from .appspec files
+    def fpm_gen *args, &block
+      require 'albacore/fpm_app_spec'
+      Albacore.define_task *args do
+        c = ::Albacore::FpmAppSpec::Config.new
+        yield c
+        ::Albacore::FpmAppSpec::Task.new(c.opts).execute
+      end
+    end
   end
 end
 

data/lib/albacore/fpm_app_spec.rb

@@ -0,0 +1,118 @@
+require 'albacore/app_spec'
+require 'map'
+
+module Albacore
+  class InvalidAppSpecError < ::StandardError
+  end
+
+  # An object that is capable of generating FPM commands - use by giving it a
+  # spec and then calling #execute or #generate_flags. You may use this object
+  # to package a directory.
+  #
+  class FpmAppSpec
+    include ::Albacore::Logging
+
+    # Initialize the object with an ::Albacore::AppSpec
+    #
+    # @param [::Albacore::AppSpec] app_spec The required package metadata.
+    # @param [PathWrap, String] output_dir_path The output path of the rpm/deb
+    #                                           package.
+    def initialize app_spec, output_dir_path = '.'
+      raise ArgumentError, 'missing app_spec parameter' unless app_spec
+      @spec = app_spec
+      @out  = output_dir_path
+    end
+
+    # Generate flags for FPM - if you don't want to execute directly with the object
+    # you can use this method to generate what you should give to FPM yourself
+    #
+    def generate_flags overrides = {}
+      { '-s'            => 'dir',
+        '-t'            => 'rpm',
+        '--name'        => @spec.title,
+        '--description' => @spec.description,
+        '--url'         => @spec.uri,
+        '--category'    => @spec.category,
+        '--version'     => @spec.version,
+        '--epoch'       => 1,
+        '--license'     => @spec.license,
+        '-C'            => @spec.dir_path,
+        '--depends'     => 'mono',
+        '--rpm-digest'  => 'sha256',
+        '--package'     => @out
+      }.merge(overrides).reject { |_, v| v.nil? }
+    end
+
+    # Generates the flags and flatten them to an array that is possible to feed
+    # into the #system command
+    #
+    def generate_flags_flat overrides = {}
+      generate_flags(overrides).map { |k, v| [k, v] }.concat(%w|--force .|).flatten
+    end
+
+    # gets the filename that the resulting file will have, based on the flags
+    # to be passed to fpm
+    def filename flags = nil
+      flags ||= generate_flags
+      # TODO: handle OS architecture properly by taking from context
+      "#{flags['--name']}-#{flags['--version']}-#{flags['--epoch']}.x86_64.rpm"
+    end
+
+    # Calls FPM with the flags generated
+    def generate
+      ::Albacore::CrossPlatformCmd.system 'fpm', generate_flags_flat
+    end
+  end
+
+  class FpmAppSpec::Config
+    # create a new configuration for multiple xxproj-s to be packed with fpm into .deb/.rpm
+    def initialize
+      @bundler = true
+    end
+
+    # turn off the using of bundler; bundler will be used by default
+    def no_bundler
+      @bundler = false
+    end
+
+    # set the output path, defaults to '.'
+    def out=
+    end
+
+    # give the configuration a list of files to match
+    def files=
+    end
+
+    def opts
+      Map.new bundler: @bundler
+    end
+  end
+
+  # task implementation that can be #execute'd
+  class FpmAppSpec::Task
+    include ::Albacore::CrossPlatformCmd
+
+    # create a new task instance with the given opts
+    def initialize opts
+      raise ArgumentError, 'opts is nil' if opts.nil?
+      @opts = opts
+    end
+
+    # this runs fpm and does some file copying
+    def execute
+      # TODO: supporting multiple projects
+
+      if opts.get :bundler
+        system 'bundle', %w|exec fpm|.concat(opts.get(:fpm_spec).generate_flags_flat)
+      else
+        system 'fpm', opts.get(:fpm_spec).generate_flags_flat
+      end
+    end
+
+    private
+    # TODO: finish
+    def specs
+      @opts.files
+    end
+  end
+end

data/lib/albacore/project.rb

@@ -28,6 +28,9 @@ module Albacore
       prop || asmname
     end
 
+    # The same as #name
+    alias_method :title, :name
+
     # get the assembly name specified in the project file
     def asmname
       read_property 'AssemblyName'
@@ -35,14 +38,23 @@ module Albacore
 
     # gets the version from the project file
     def version
-      read_property "Version"
+      read_property 'Version'
     end
 
     # gets any authors from the project file
     def authors
-      read_property "Authors"
+      read_property 'Authors'
     end 
 
+    def description
+      read_property 'Description'
+    end
+
+    # the license that the project has defined in the metadata in the xxproj file.
+    def license
+      read_property 'License'
+    end
+
     # gets the output path of the project given the configuration or raise
     # an error otherwise
     def output_path conf

data/lib/albacore/version.rb

@@ -1,3 +1,3 @@
 module Albacore
-  VERSION = "2.0.0.rc.13"
+  VERSION = "2.0.0.rc.14"
 end

data/spec/app_spec_spec.rb

@@ -0,0 +1,145 @@
+require 'xsemver'
+require 'albacore/app_spec'
+
+describe ::Albacore::AppSpec, 'public API with defaults' do
+  subject do
+    ::Albacore::AppSpec.new 'missing-path', %{
+---
+title: superapp.now
+project_path: spec/testdata/Project/Project.fsproj
+}
+  end
+
+  %w|title description uri category version license dir_path to_s|.map { |w| :"#{w}" }.each do |s|
+    it "should respond to ##{s}" do
+      subject.should respond_to s
+    end
+
+    it "should be possible to always call ##{s}" do
+      subject.method(s).call
+    end
+  end
+
+  it 'should have correct title' do
+    subject.title.should eq 'superapp.now'
+  end
+
+  it 'should have nil license' do
+    subject.license.should be_nil
+  end
+
+  it 'should have nil description' do
+    subject.description.should be_nil
+  end
+
+  it 'should never have nil uri, since we\'re in the albacore git repo and it defaults to the current repo' do
+    subject.uri.should include 'albacore.git'
+  end
+
+  it 'should have "apps" category, since it\'s not specified anywhere' do
+    subject.category.should eq 'apps'
+  end
+
+  it 'should have a nil version' do
+    subject.version.should eq('1.0.0')
+  end
+
+  it 'should have non-nil #bin_folder' do
+    subject.bin_folder.should_not be_nil
+  end
+
+  it 'should have non-nil #conf_folder' do
+    subject.conf_folder.should_not be_nil
+  end
+
+  it 'should have non-nil #contents' do
+    subject.contents.should_not be_nil
+  end
+
+  it 'should have a #contents that responds to #each' do
+    subject.contents.should respond_to :each
+  end
+end
+
+describe ::Albacore::AppSpec, 'public API with required fields' do
+  subject do
+    ::Albacore::AppSpec.new 'missing-.appspec-path', %{
+---
+title: superapp.now
+project_path: spec/testdata/Project/Project.fsproj
+}
+  end
+
+  # TODO: create a spike that actually works and document what is required here  
+end
+
+describe ::Albacore::AppSpec, 'when getting version from semver' do
+  subject do
+    ::Albacore::AppSpec.new 'missing-.appspec-path', %{
+---
+title: zeeky
+version: 4.5.6
+project_path: spec/testdata/Project/Project.fsproj
+}, XSemVer::SemVer.new(1,2,3)
+  end
+
+  it 'should take version from the semver first' do
+    subject.version.should eq '1.2.3'
+  end
+end
+
+describe ::Albacore::AppSpec, 'when getting version from yaml' do
+  subject do
+    ::Albacore::AppSpec.new 'missing-.appspec-path', %{
+---
+title: smurfs.abound
+version: 4.5.6
+project_path: spec/testdata/Project/Project.fsproj
+}, nil
+  end
+
+  it 'should take version from the semver first' do
+    subject.version.should eq '4.5.6'
+  end
+end
+
+describe ::Albacore::AppSpec, 'when giving invalid project path' do
+  it 'should raise ArgumentError when path doesn\'t exist' do
+    expect {
+      ::Albacore::AppSpec.new 'missing-.appspec-path', %{---
+project_path: path/not/existent/proj.fsproj}, nil
+    }.to raise_error(ArgumentError)
+  end
+
+  it 'should raise ArgumentError when no value given' do
+    expect {
+      ::Albacore::AppSpec.new 'missing-.appspec-path', %{---
+title: my.project}, nil
+    }.to raise_error(ArgumentError)
+  end
+  
+end
+
+describe ::Albacore::AppSpec, 'when fetching ALL data from Project.fsproj' do
+  let :project_path do
+    'spec/testdata/Project/Project.appspec'
+  end
+
+  subject do
+    ::Albacore::AppSpec.load project_path
+  end
+
+  it 'should find the directory of the project' do
+    # this also means it found a project and successfully parsed its project
+    # definition
+    subject.proj.proj_path_base.should include File.dirname(project_path)
+  end
+
+  it 'should have the title' do
+    subject.title.should eq 'project'
+  end
+
+  it 'should have no license' do
+    subject.license.should be_nil
+  end
+end

data/spec/dsl_spec.rb

@@ -14,7 +14,7 @@ end
 
 #puts "X has methods: #{X.new.private_methods.inspect}"
 
-%w[nugets_restore nugets_pack asmver build test_runner restore_hint_paths].each do |sym|
+%w[nugets_restore nugets_pack asmver build test_runner restore_hint_paths fpm_gen].each do |sym|
   method = :"#{sym}"
   describe "that #{method}(*args, &block) is included when doing `require 'albacore'`" do
     subject do

data/spec/fpm_app_spec_spec.rb

@@ -0,0 +1,156 @@
+require 'xsemver'
+require 'albacore/app_spec'
+require 'albacore/fpm_app_spec'
+
+shared_context 'valid AppSpec' do
+  let :spec do
+    ::Albacore::AppSpec.new '/a/b/c.appspec', %{
+---
+title: my.app
+project_path: spec/testdata/Project/Project.fsproj
+version: 1.2.3
+license: MIT
+description: my.app implements much wow
+uri: https://github.com/Albacore/albacore
+category: webserver
+}, XSemVer::SemVer.new(5, 6, 7)
+  end
+end
+
+describe ::Albacore::FpmAppSpec, 'public API' do
+  include_context 'valid AppSpec'
+
+  subject do
+    ::Albacore::FpmAppSpec.new spec
+  end
+
+  it do
+    should respond_to :filename
+  end
+
+  it 'should know resulting filename' do
+    subject.filename.should eq('my.app-5.6.7-1.x86_64.rpm')
+  end
+
+  it do
+    should respond_to :generate
+  end
+
+  it do
+    should respond_to :generate_flags
+  end
+end
+
+
+describe ::Albacore::FpmAppSpec, 'when generating command from valid AppSpec' do
+  include_context 'valid AppSpec'
+
+  subject do
+    ::Albacore::FpmAppSpec.new spec
+  end
+
+  let :flags do
+    subject.generate_flags
+  end
+
+  it 'should generate command source' do
+    flags['-s'].should eq 'dir'
+  end
+
+  it 'should generate command target' do
+    flags['-t'].should eq 'rpm'
+  end
+
+  it 'should generate command name/title' do
+    flags['--name'].should eq 'my.app'
+  end
+
+  it 'should generate command description' do
+    flags['--description'].should eq 'my.app implements much wow'
+  end
+
+  it 'should generate command url' do
+    flags['--url'].should eq 'https://github.com/Albacore/albacore'
+  end
+
+  it 'should generate command category' do
+    flags['--category'].should eq 'webserver'
+  end
+
+  it 'should generate command version' do
+    flags['--version'].should eq '5.6.7'
+  end
+
+  it 'should generate command epoch' do
+    flags['--epoch'].should eq 1
+  end
+
+  it 'should generate command license' do
+    flags['--license'].should eq 'MIT'
+  end
+
+  it 'should generate command "look in this directory" flag' do
+    flags['-C'].should eq '/a/b'
+  end
+
+  it 'should generate command depends' do
+    flags['--depends'].should eq 'mono'
+  end
+
+  it 'should generate command rpm-digest' do
+    flags['--rpm-digest'].should eq 'sha256'
+  end
+end
+
+describe ::Albacore::FpmAppSpec, 'validation method' do
+  include_context 'valid AppSpec'
+
+  subject do
+    # TODO: construct
+  end
+  # TODO: to validate
+end
+
+describe ::Albacore::FpmAppSpec, 'when generating command from in-valid AppSpec' do
+  let :spec do
+    ::Albacore::AppSpec.new 'missing descriptor path', %{
+---
+title: my.app
+project_path: spec/testdata/Project/Project.fsproj
+}, XSemVer::SemVer.new(5, 6, 7)
+  end
+
+  it 'should raise InvalidAppSpecError' do
+    expect { ::Albacore::FpmAppSpec.new spec }.to raise_error ::Albacore::InvalidAppSpecError
+  end
+end
+
+describe ::Albacore::FpmAppSpec, 'should never generate nils' do
+  let :spec do
+    ::Albacore::AppSpec.new 'missing descriptor path', %{
+---
+title: my.app
+project_path: spec/testdata/Project/Project.fsproj
+}, XSemVer::SemVer.new(5, 6, 7)
+  end
+
+  subject do
+    ::Albacore::FpmAppSpec.new spec 
+  end
+
+  it 'should not have a license' do
+    spec.license.should be_nil
+  end
+  
+  it 'that license should never be a FPM parameter' do
+    subject.generate_flags.has_key?('--license').should be_false
+  end
+end
+
+describe ::Albacore::FpmAppSpec::Config do
+  %w|files= out= opts no_bundler|.each do |sym|
+    it "should respond_to :#{sym}" do
+      should respond_to :"#{sym}"
+    end
+  end
+end

data/spec/testdata/Project/Project.appspec

@@ -0,0 +1 @@
+---

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: albacore
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc.13
+  version: 2.0.0.rc.14
   prerelease: 6
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-20 00:00:00.000000000 Z
+date: 2014-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -176,6 +176,7 @@ files:
 - albacore.gemspec
 - lib/albacore.rb
 - lib/albacore/albacore_module.rb
+- lib/albacore/app_spec.rb
 - lib/albacore/application.rb
 - lib/albacore/cmd_config.rb
 - lib/albacore/config_dsl.rb
@@ -187,6 +188,7 @@ files:
 - lib/albacore/ext/README.md
 - lib/albacore/ext/teamcity.rb
 - lib/albacore/facts.rb
+- lib/albacore/fpm_app_spec.rb
 - lib/albacore/logging.rb
 - lib/albacore/nuget_model.rb
 - lib/albacore/package.rb
@@ -218,6 +220,7 @@ files:
 - lib/albacore/version.rb
 - spec/Rakefile
 - spec/albacore_spec.rb
+- spec/app_spec_spec.rb
 - spec/asmver_spec.rb
 - spec/asmver_task_spec.rb
 - spec/build_spec.rb
@@ -226,6 +229,7 @@ files:
 - spec/dsl_spec.rb
 - spec/ext_teamcity_spec.rb
 - spec/facts_spec.rb
+- spec/fpm_app_spec_spec.rb
 - spec/nuget_model_spec.rb
 - spec/nugets_pack_spec.rb
 - spec/nugets_restore_spec.rb
@@ -277,6 +281,7 @@ files:
 - spec/testdata/Gemfile
 - spec/testdata/NuGet.exe
 - spec/testdata/Project/Library1.fs
+- spec/testdata/Project/Project.appspec
 - spec/testdata/Project/Project.fsproj
 - spec/testdata/Project/Project.sln
 - spec/testdata/Project/Project.v11.suo
@@ -317,7 +322,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 799826362560465067
+      hash: -504786499595810367
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -333,6 +338,7 @@ summary: Dolphin-safe and awesome Mono and .Net Rake-tasks
 test_files:
 - spec/Rakefile
 - spec/albacore_spec.rb
+- spec/app_spec_spec.rb
 - spec/asmver_spec.rb
 - spec/asmver_task_spec.rb
 - spec/build_spec.rb
@@ -341,6 +347,7 @@ test_files:
 - spec/dsl_spec.rb
 - spec/ext_teamcity_spec.rb
 - spec/facts_spec.rb
+- spec/fpm_app_spec_spec.rb
 - spec/nuget_model_spec.rb
 - spec/nugets_pack_spec.rb
 - spec/nugets_restore_spec.rb
@@ -392,6 +399,7 @@ test_files:
 - spec/testdata/Gemfile
 - spec/testdata/NuGet.exe
 - spec/testdata/Project/Library1.fs
+- spec/testdata/Project/Project.appspec
 - spec/testdata/Project/Project.fsproj
 - spec/testdata/Project/Project.sln
 - spec/testdata/Project/Project.v11.suo