albacore 2.0.0.rc.18 → 2.0.0.rc.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3adb7ca26eb58c83011c056ec55d4fe3022225d7
-  data.tar.gz: 9d32ba36a45484bc4b9d3f4266c8fed4a69abb62
+  metadata.gz: 2dd6c3c5bcb5a1347b929ea6c71b772f47420c64
+  data.tar.gz: e1186cdedddd11f7356ee98b6705c26c507f3149
 SHA512:
-  metadata.gz: 1ac4d76af91d85c459b9acb7d8f5c705e0d65604ae805c770db33109436b67a80548c83e9f6e704760a6eb9837571392b614258894a8366187b5e38be2227efc
-  data.tar.gz: 1d23c2bb643d2381d1d981e9b9ed1949a7e201ecfe15802526e9244f84339e59f21da71e7448507f69ae5a1a1b5515a75f3ba9fcba5874b7b211c91ad135683b
+  metadata.gz: 90bf3a0884528bee5deba2cb0156d07c71f46570c67e3cb9ee4facd0a5a61633cb4b8e308faa49fa3ff70559725cb2ed29cbf560a3730ffd3a542d53dfa5ffa1
+  data.tar.gz: 49154665a384a529ab5cde6f68fe41330cef777d0874c15ea7ebaf8cf6e62b4ebda2db918718f10148319e05d4311bc91e9653bd5f7ad5bd49cb5137b8ad7b27

data/README.md

@@ -114,12 +114,13 @@ When you `require 'albacore'` you will get a few methods added and available for
 use within your Rakefile, these are specified in CrossPlatformCmd, and are as
 follows:
 
- - `#system`
- - `#sh`
- - `#shie`
- - `#system_control`
- - `#which`
- - `#normalise_slashes` 
+ - `#system` : (processPath : string) -> (arguments : string array)
+ - `#sh` : same as above
+ - `#shie` : same as above
+ - `#which` : (binaryName : string) -> (path : string)
+ - `#normalise_slashes`  - takes a path-looking string and normalises the
+   slashes to the operating system that the command is running on. So for
+   Windows, you'd get back-slashes and for linux forward slashes.
  - `#chdir (work_dir : ?string) (block : Block<unit, x>) : x` - takes a string work dir to be
    in and a block of ruby to execute in that work dir and returns the return
    value of block.
@@ -265,9 +266,11 @@ TBD
 
 ### Docs: appspecs
 
-Example rakefile (see spec/test_appspecs/corp.service in albacore source).
+Example rakefile (see
+[spec/test_appspecs/corp.service](https://github.com/Albacore/albacore/tree/master/spec/test_appspecs/corp.service)
+in albacore source).
 
-```
+``` ruby
 require 'bundler/setup'
 require 'albacore'
 
@@ -300,6 +303,63 @@ automatically become a chocolatey package server that you can use
 packages of on your Windows boxen. Or you can use puppet proper with a yum repo
 on your linux boxen.
 
+The appspec simply looks something like this:
+
+``` yaml
+---
+version: 1.2.3
+authors: Henrik Feldt
+```
+
+You can put any nuget-spec property there in `snake_case` and it will be set in
+the resulting nuget file. When building RPMs, the title of the project file will
+be used as the id (the non-lowercased title will be used for the NuGet).
+
+This task-type works by checking if it's running on Windows, and then running
+chocolatey, otherwise running fpm. This means that you have to have either
+installed, depending on your OS of choice.
+
+### Known .appspec options
+
+**project_path** - if you are, say, building a package from a web site (like
+CSharpWeb is an example of), then you probably don't want to package all of your
+.cs files, nor would you like to package only the bin folder. Instead you add
+the .appspec to the list of files in the csproj file, so that it gets copied
+when you have a local publish like this:
+
+``` ruby
+build :pkg_web do |b|
+  b.file = 'CSharpWeb/CSharpWeb.csproj'
+  b.prop 'DeployOnBuild',  'true'
+  b.prop 'PublishProfile', 'local'
+  b.prop 'Configuration',  Configuration
+end
+```
+
+After calling this task, you'll find the appspec at `CSharpWeb/build/.appspec`
+(which mean it's part of the contents of the site). Now it's easy for albacore
+to find it and create a package from it, but it can't easily find the project
+that corresponds to it, because it's not next to the csproj file.
+
+This is where `project_path` comes in; make it something like
+`../CSharpWeb.csproj` in the .appspec file and then albacore knows where to get
+the data from.
+
+**provider** - `defaults` or `iis_site` -- needs to be specified currently if
+you're building a site -- a nice PR would be to discover that from the project
+type.
+
+**deploy_dir** - fully qualified path to deploy the contents
+
+#### Example IIS Site `.appspec` file
+
+``` yaml
+---
+authors: Intelliplan Employees
+provider: iis_site
+project_path: ../CMDB.Web.csproj
+```
+
 ## Tasks
 
 Tasks are things you can include that create singleton ruby tasks that are

data/albacore.gemspec

@@ -24,7 +24,7 @@ EOF
   s.add_dependency 'rake', '>10' # this gem builds on rake
   s.add_dependency 'map', '~>6.5' # https://github.com/ahoward/map for options handling
   s.add_dependency 'nokogiri', '~> 1.5' # used to manipulate and read *proj files
-  s.add_dependency 'semver2', '~> 3.3'
+  s.add_dependency 'semver2', '~> 3.4'
 	
   s.add_development_dependency 'rubygems-tasks', '~>0.2'
   s.add_development_dependency 'rspec', '>= 2.13'

data/lib/albacore/app_spec.rb

@@ -28,6 +28,27 @@ module Albacore
       @semver = semver
     end
 
+    # Gets the path that the .appspec file was read from when it was initialised.
+    #
+    def path
+      @path
+    end
+
+    # Gets the executable name if this service has one -- defaults to the
+    # assembly name of the corresponding project, plus 'exe', which is how the
+    # compilers name the executables.
+    #
+    def exe
+      conf['exe'] || "#{proj.asmname}.exe"
+    end
+
+    # Gets the location fully qualified path that the finished artefact will be
+    # installed into. Defaults to C:\\Services\\{id}.
+    #
+    def deploy_dir
+      conf['deploy_dir'] || "C:\\Services\\#{id}"
+    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.
@@ -115,25 +136,36 @@ module Albacore
       semver_version || ENV['FORMAL_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)
+    # 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
+    # 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
+    # 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
+    # gets the provider to use to calculate the directory paths to construct
+    # inside the nuget
+    #
+    # defaults to the 'defaults' provider which can be found in
+    # 'albacore/app_spec/defaults.rb'
+    def provider
+      conf['provider'] || 'defaults'
+    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

data/lib/albacore/app_spec/README.md

@@ -0,0 +1,4 @@
+# app_spec providers
+
+Place different providers in this folder, that allows you to change how albacore
+handles content for different types of projects.

data/lib/albacore/app_spec/defaults.rb

@@ -0,0 +1,61 @@
+require 'albacore/app_spec'
+
+# note: this is a Windows provider
+
+module Albacore
+  # The default is to get the bin/ folder based on the configuration that you
+  # have compiled the project with.
+  #
+  class AppSpec::Defaults
+    include ::Albacore::Logging
+
+    # location/folder inside nuget to place everything found in the
+    # #relative_dir inside
+    def nuget_contents
+      'bin'
+    end
+
+    # Where to copy contents from
+    def source_dir app_spec, configuration = 'Release'
+      File.join(app_spec.proj.proj_path_base,
+                app_spec.bin_folder(configuration),
+                '.').
+           gsub(/\//, '\\')
+    end
+
+    # create a chocolatey install script for a topshelf service on windows
+    #
+    # write tools/chocolateyInstall.ps1
+    def install_script out, app_spec, &block
+      debug { "installing into '#{out}' [app_spec/defaults#install_script]" }
+      tools = "#{out}/#{app_spec.id}/tools"
+
+      FileUtils.mkdir tools unless Dir.exists? tools
+      File.open(File.join(tools, 'chocolateyInstall.ps1'), 'w+') do |io|
+        contents = embedded_resource '../../../resources/chocolateyInstall.ps1'
+        io.write contents
+        write_invocation app_spec, io
+      end
+    end
+
+    # Get the relative resource from 'albacore/app_spec/.' as a string.
+    def embedded_resource relative_path
+      File.open(embedded_resource_path(relative_path), 'r') { |io| io.read }
+    end
+
+    # Get the relative resource path from 'albacore/app_spec/.'
+    def embedded_resource_path relative_path
+      File.join(File.dirname(File.expand_path(__FILE__)), relative_path)
+    end
+
+    def write_invocation app_spec, io
+      debug { 'writing default powershell invocation [app_spec/defaults#write_invocation]' }
+
+      io.write %{
+Install-Service `
+  -ServiceExeName "#{app_spec.exe}" -ServiceDir "#{app_spec.deploy_dir}" `
+  -CurrentPath (Split-Path $MyInvocation.MyCommand.Path)
+}
+    end
+  end
+end

data/lib/albacore/app_spec/iis_site.rb

@@ -0,0 +1,42 @@
+require 'albacore/app_spec'
+
+module Albacore
+  # In the case of building an IIS site we expect the site to have been
+  # 'Published' to a specific folder from which we can then fetch the contents.
+  #
+  # If you want the default behaviour of only packaging the bin/ folder with the
+  # compiled artifacts, use 'albacore/app_spec/defaults' instead.
+  #
+  # While this class is inheriting the defaults, it's still overriding
+  # almost/all methods.
+  class AppSpec::IisSite < AppSpec::Defaults
+    include ::Albacore::Logging
+    include ::Albacore::CrossPlatformCmd
+
+    # location/folder inside nuget to place everything found in the
+    # #source_dir inside
+    def nuget_contents
+      'contents'
+    end
+
+    # where to copy from - will copy ALL contents of this directory - in this
+    # case will copy from the directory that the appspec is in.
+    def source_dir app_spec, configuration = 'Release'
+      "#{File.dirname(app_spec.path)}/."
+    end
+
+    # Extends the outputted data with the installation routines
+    def write_invocation app_spec, io
+      debug { 'writing iis site installation invocation [app_spec/iis_site#write_invocation]' }
+
+      site_installation_function = embedded_resource '../../../resources/installSite.ps1'
+      io.write %{
+#{site_installation_function}
+
+# deliberately lowercase id/name/title.
+Install-Site -SiteName '#{app_spec.title}' `
+    -WebSiteRootFolder '#{normalise_slashes(File.expand_path('..', app_spec.deploy_dir))}'
+}
+    end
+  end
+end

data/lib/albacore/cpack_app_spec.rb

@@ -67,7 +67,10 @@ module Albacore
     end
 
     def git_release_notes
-      tags = `git tag`.split(/\n/)
+      tags = `git tag`.split(/\n/).
+                map { |tag| [ ::XSemVer::SemVer.parse_rubygems(tag), tag ] }.
+                sort { |a, b| a <=> b }.
+                map { |_, tag| tag }
       last_tag = tags[-1]
       second_last_tag = tags[-2] || `git rev-list --max-parents=0 HEAD`
       logs = `git log --pretty=format:%s #{second_last_tag}..`.split(/\n/)
@@ -84,8 +87,8 @@ module Albacore
         m.version       = app_spec.version
         m.authors       = app_spec.authors
         m.owners        = app_spec.owners
-        m.description   = app_spec.description || app_spec.title
-        m.release_notes = git_release_notes
+        m.description   = app_spec.description || app_spec.title_raw
+        m.release_notes = app_spec.release_notes || git_release_notes
         m.summary       = app_spec.summary
         m.language      = app_spec.language
         m.project_url   = app_spec.project_url || 'https://haf.se'
@@ -97,43 +100,25 @@ module Albacore
       p.to_xml
     end
 
-    # create a chocolatey install script for a topshelf service on windows
-    def create_chocolatey_install out, service_dir, exe, app_spec
-      tools = "#{out}/#{app_spec.id}/tools"
-
-      FileUtils.mkdir tools unless Dir.exists? tools
-      File.open(File.join(tools, 'chocolateyInstall.ps1'), 'w+') do |io|
-        contents = embedded_resource '../../resources/chocolateyInstall.ps1'
-        io.write contents
-        io.write %{
-Install-Service `
-  -ServiceExeName "#{exe}" -ServiceDir "#{service_dir}" `
-  -CurrentPath (Split-Path $MyInvocation.MyCommand.Path)
-}
-      end
-    end
-
     def create_cpack out, app_spec, nuspec_xml, configuration
+      provider = find_provider app_spec
+
       target = "#{out}/#{app_spec.id}"
-      bin = "#{target}/bin"
+      contents = "#{target}/#{provider.nuget_contents}/"
 
-      # create target
+      debug { 'create target [cpack_app_spec#create_cpack]' }
       FileUtils.mkdir_p target
 
-      # write nuspec
+      debug { 'write nuspec [cpack_app_spec#create_cpack]' }
       File.open("#{target}/#{app_spec.id}.nuspec", 'w+') { |io| io.write nuspec_xml }
 
-      # write tools
-      create_chocolatey_install out,
-                                app_spec.exe,
-                                "#{app_spec.target_root_dir}\\#{app_spec.id}",
-                                app_spec
+      debug { 'write tools/chocolateyInstall.ps1 [cpack_app_spec#create_cpack]' }
+      provider.install_script out, app_spec
 
-      # copy contents of package
-      proj_path = File.join(app_spec.proj.proj_path_base,
-                            app_spec.proj.output_path(configuration), '.').
-                    gsub(/\//, '\\')
-      FileUtils.cp_r proj_path, bin, :verbose => true
+      debug { 'copy contents of package [cpack_app_spec#create_cpack]' }
+      FileUtils.cp_r provider.source_dir(app_spec, configuration),
+                     contents,
+                     :verbose => true
 
       # package it
       Dir.chdir target do
@@ -141,15 +126,21 @@ Install-Service `
       end
 
       # publish it
-      Albacore.publish :artifact, OpenStruct.new(:location => "#{target}/*.nupkg")
+      Albacore.publish :artifact, OpenStruct.new(
+        :location => "#{target}/#{app_spec.id}.#{app_spec.version}.nupkg"
+      )
     end
 
-    def embedded_resource relative_path
-      File.open(embedded_resource_path(relative_path), 'r') { |io| io.read }
-    end
-
-    def embedded_resource_path relative_path
-      File.join(File.dirname(File.expand_path(__FILE__)), relative_path)
+    def find_provider app_spec
+      require "albacore/app_spec/#{app_spec.provider}"
+      case app_spec.provider
+      when 'defaults'
+        AppSpec::Defaults.new
+      when 'iis_site'
+        AppSpec::IisSite.new
+      else
+        raise ArgumentError, "unknown app_spec.provider: #{app_spec.provider}"
+      end
     end
   end
 end

data/lib/albacore/version.rb

@@ -1,3 +1,3 @@
 module Albacore
-  VERSION = "2.0.0.rc.18"
+  VERSION = "2.0.0.rc.19"
 end

data/resources/installSite.ps1

@@ -0,0 +1,50 @@
+Import-Module WebAdministration
+
+Function Install-Site(
+    # Folder where all your websites are located
+    [string] $WebSiteRootFolder = "C:\WebSites",
+
+    # The port your default binding is using
+    [int] $Port = 80,
+
+    # Where the source files are -- without any trailing slash or otherwise --
+    # just the name, please.
+    [string] $SourceDirectory = "source",
+
+    # Name of site that you're setting up
+    [string] $SiteName
+) {
+    #site folder
+    $siteInstallLocation = "$WebSiteRootFolder\$SiteName"
+
+    #site application pool
+    $siteAppPool = "$SiteName-pool"
+
+    #check if the site is already present (determines update or install)
+    $isPresent = Get-Website -name $siteName 
+
+    if($isPresent){
+        # Upgrade the current package
+        Write-Host "$SiteName will be updated"
+        Copy-Item "$SourceDirectory\*" -Recurse $siteInstallLocation -Force
+    } else {
+        # Install a clean version of the package
+
+        Write-Host "$SiteName will be installed"
+
+        # Create site folder
+        new-item $siteInstallLocation -ItemType directory -Force
+
+        # Copy site files to site folder
+        Copy-Item $SourceDirectory -Recurse $siteInstallLocation -Force
+
+        # Create application pool
+        New-WebAppPool -Name $siteAppPool -Force
+
+        $hostHeader = Invoke-Expression "facter fqdn"
+
+        # Create site
+        New-Website -Name $SiteName -Port $Port -HostHeader $hostHeader `
+            -ApplicationPool $siteAppPool -PhysicalPath $siteInstallLocation
+    }
+}