samus 1.6.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 8a296d7f542703df6cf792c6e304b0836689f2fecf47454225dfe50d60045ced
-  data.tar.gz: be6e1b20ba87c084858060c2d607b27e5193f55ecd6cfa9287fd3ab22df091a9
+SHA1:
+  metadata.gz: dfd222e26ed2614c6604f9323ee6351725fa5b06
+  data.tar.gz: 6c06fedbabcc7ea4579c15028f9ac5efdb19f61e
 SHA512:
-  metadata.gz: 2f599e0394de30729586d82c8c2557cbe7cc3b7eb3968c013fa18b8e70a6704f0dc8cc841e738c2d61baa6be3b677b6d5740b82b946a0bd5d81fe73c1424292d
-  data.tar.gz: 44fe1f224fcfe46d72ad27f9da76c7d04b011e4739e5682e254610691626b8169eb72059e7dbebb6d78bd0bc9fcdf7abb99bf19061388338fe757b64961b3386
+  metadata.gz: d1c024b9d0673fea1b125c8d709fceb0ee4a36b2e4086472894fcc18e6179803d53c591635f7de61a775e05f3e0bb88546d3847a6bc43ceea13a500d8f124f6c
+  data.tar.gz: 865798d531d3bab1c5315ffc0456ce21fc7e1db35a22b220b674167abf4dc89886f4d61330305346568338670882fe01654f5ff2c271f2b19addc6c5b232e590

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 2.0.0 - August 9th, 2018
+
+- Add support for Windows. This caused a backwards incompatible change where
+  environment variables are now UPPERCASED by default. In general this should
+  have no effect if you rely only on built-in scripts.
+- Report an error if credentials cannot be parsed.
+
 # 1.6.0 - July 19, 2018
 
 - Add support for credentials for git-push. Add a credentials file with

data/README.md

@@ -221,10 +221,10 @@ as environment variables with a prefixed underscore. For example, the
 ```sh
 #!/bin/sh
 
-rake $_task
+rake $_TASK
 ```
 
-The `$_task` variable is the "task" argument from the manifest.
+The `$_TASK` variable is the "task" argument from the manifest.
 
 Note that commands must be executable (`chmod +x`) and have proper shebang
 lines or they will not function.
@@ -240,18 +240,18 @@ commands directory depending on whether they are for `samus build` or
 In addition to exposing arguments as underscored environment variables,
 Samus also exposes a few special variables with double underscore prefixes:
 
-* `__build_dir` - this variable refers to the temporary directory that the
+- `__build_dir` - this variable refers to the temporary directory that the
   release package is being built inside of. The files inside of this directory,
-  and *only* the files inside of this directory, will be built into the release
+  and _only_ the files inside of this directory, will be built into the release
   archive. If you write a build-time command that produces an output file which
   is part of the release, you should make sure to move it into this directory.
-* `__restore_file` - the restore file is a newline delimited file containing
+- `__restore_file` - the restore file is a newline delimited file containing
   branches and their original ref. All branches listed in this file will be
   restored to the respective ref at the end of `samus build` regardless of
   success status. If you make destructive modifications to existing branches
   in the workspace repository, you should add the original ref for the branch
   to this file.
-* `__creds_*` - provides key, secret, and other values loaded from credentials.
+- `__creds_*` - provides key, secret, and other values loaded from credentials.
   See Credentials section for more information on how these are set.
 
 #### Help Files
@@ -273,9 +273,9 @@ Short description of command.
 
 Notes:
 
-* The first line of the help file is used as the summary in the `show-cmd`
+- The first line of the help file is used as the summary in the `show-cmd`
   listing.
-* Never omit a section. If a command has no files or arguments, use "(none)"
+- Never omit a section. If a command has no files or arguments, use "(none)"
   as the list item text.
 
 ### Credentials
@@ -297,12 +297,12 @@ Key: THE_API_KEY
 Secret: THE_SECRET
 ```
 
-Or, alternatively, an *executable* which prints the above format to standard
+Or, alternatively, an _executable_ which prints the above format to standard
 out.
 
-These values are read in by Samus and get exposed as `$__creds_key` and
-`$__creds_secret` respectively in Samus commands. You can provide other
-metadata as well, which would be included as `$__creds_name` (for the
+These values are read in by Samus and get exposed as `$__CREDS_KEY` and
+`$__CREDS_SECRET` respectively in Samus commands. You can provide other
+metadata as well, which would be included as `$__CREDS_NAME` (for the
 line "NAME: value").
 
 ## Manifest File Format
@@ -337,7 +337,7 @@ Each action item has a single required property, "action", which is the command
 to execute for the action (found in `samus show-cmd`). An optional list of
 files are passed into the command as command line arguments, and the "arguments"
 property is a map of keys to values passed in as environment variables with a
-"\_" prefix (key "foo" is set as environment variable "_foo"). Optional
+"\_" prefix (key "foo" is set as environment variable "\_foo"). Optional
 credentials are loaded from the credentials directory.
 
 ### Build Manifest Format

data/commands/build/archive-git-full

@@ -2,4 +2,4 @@
 
 set -e
 git gc # might as well GC before archiving .git
-tar cfz $__build_dir/$1 .git $(git ls-files)
+tar cfz $__BUILD_DIR/$1 .git $(git ls-files)

data/commands/build/archive-tgz

@@ -1,3 +1,3 @@
 #!/bin/sh
 
-tar cfz $__build_dir/$1 $_paths
+tar cfz $__BUILD_DIR/$1 $_PATHS

data/commands/build/archive-zip

@@ -1,3 +1,3 @@
 #!/bin/sh
 
-zip -qr $__build_dir/$1 $_paths
+zip -qr $__BUILD_DIR/$1 $_PATHS

data/commands/build/changelog-parse

@@ -16,5 +16,5 @@ def parse_changelog(changelog)
 end
 
 file = ARGV[0]
-dest = File.join(ENV["__build_dir"], ENV["_destination"] || file)
+dest = File.join(ENV["__BUILD_DIR"], ENV["_DESTINATION"] || file)
 File.open(dest, "w") {|f| f.puts(parse_changelog(file)) }

data/commands/build/fs-copy

@@ -1,3 +1,3 @@
 #!/bin/sh
 
-cp -r $* $__build_dir/$_destination
+cp -r $* $__BUILD_DIR/$_DESTINATION

data/commands/build/fs-mkdir

@@ -1,3 +1,3 @@
 #!/bin/sh
 
-mkdir -p $__build_dir/$*
+mkdir -p $__BUILD_DIR/$*

data/commands/build/fs-sedfiles

@@ -2,6 +2,6 @@
 
 ARGV.map {|f| Dir.glob(f) }.flatten.each do |file|
   contents = File.read(file)
-  contents = contents.gsub(Regexp.new(ENV['_search']), ENV['_replace'])
+  contents = contents.gsub(Regexp.new(ENV['_SEARCH']), ENV['_REPLACE'])
   File.open(file, 'w') {|f| f.write(contents) }
 end

data/commands/build/gem-build

@@ -1,5 +1,5 @@
 #!/bin/sh
 
 set -e
-gem build $1
-mv ${1%.gemspec}-$_version.gem $__build_dir
+ruby -S gem build $1
+mv ${1%.gemspec}-$_VERSION.gem $__BUILD_DIR

data/commands/build/git-archive

@@ -1,3 +1,3 @@
 #!/bin/sh
 
-git archive --prefix="$_prefix" -o $__build_dir/$1 ${_ref-HEAD}
+git archive --prefix="$_PREFIX" -o $__BUILD_DIR/$1 ${_REF-HEAD}

data/commands/build/git-clone

@@ -1,8 +1,8 @@
 #!/bin/sh
 
 set -e
-git clone -q --branch ${_branch-master} \
-  ${_repository-.} $__build_dir/$1 2>/dev/null
+git clone -q --branch ${_BRANCH-master} \
+  ${_REPOSITORY-.} $__BUILD_DIR/$1 2>${__DEVNULL-/dev/null}
 
 # preserve all previously configured remotes for publish actions
-cp ${_repository-.}/.git/config $__build_dir/$1/.git/config
+cp ${_REPOSITORY-.}/.git/config $__BUILD_DIR/$1/.git/config

data/commands/build/git-commit

@@ -7,5 +7,5 @@ message=$($(dirname $0)/support/generate-commit-message.rb)
 
 git add $*
 git commit -m "$message"
-git tag ${_tag-v$_version}
-echo tag ${_tag-v$_version} >> $__restore_file
+git tag ${_TAG-v$_VERSION}
+echo tag ${_TAG-v$_VERSION} >> $__RESTORE_FILE

data/commands/build/git-merge

@@ -1,9 +1,9 @@
 #!/bin/sh
 
 set -e
-git fetch ${_remote-origin}
-git checkout -q $_branch
-echo branch $_branch $(git rev-parse HEAD) >> $__restore_file
-git rebase ${_remote-origin}/$_branch
-git merge $__build_branch -q -m "Merge release branch into $_branch" -s recursive -Xtheirs --ff
-git checkout -q $__build_branch
+git fetch ${_REMOTE-origin}
+git checkout -q $_BRANCH
+echo branch $_BRANCH $(git rev-parse HEAD) >> $__RESTORE_FILE
+git rebase ${_REMOTE-origin}/$_BRANCH
+git merge $__BUILD_BRANCH -q -m "Merge release branch into $_BRANCH" -s recursive -Xtheirs --ff
+git checkout -q $__BUILD_BRANCH

data/commands/build/make-task

@@ -1,3 +1,3 @@
 #!/bin/sh
 
-make $_task
+make $_TASK

data/commands/build/npm-pack

@@ -1,4 +1,4 @@
 #!/bin/sh
 
 set -e
-mv `npm pack` $__build_dir/$1
+mv `npm pack` $__BUILD_DIR/$1

data/commands/build/npm-task

@@ -1,3 +1,3 @@
 #!/bin/sh
 
-npm $_task $*
+npm $_TASK $*

data/commands/build/rake-task

@@ -1,3 +1,3 @@
 #!/bin/sh
 
-rake $_task
+rake $_TASK

data/commands/build/samus-build

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 set -e
-bakfile=${__restore_file}.$$.$RANDOM.bak
-mv $__restore_file $bakfile
-trap "mv $bakfile $__restore_file" 0
-samus build -o $__build_dir/$1 $_build_version ${_manifest}
+bakfile=${__RESTORE_FILE}.$$.$RANDOM.bak
+mv $__RESTORE_FILE $bakfile
+trap "mv $bakfile $__RESTORE_FILE" 0
+samus build -o $__BUILD_DIR/$1 $_BUILD_VERSION ${_MANIFEST}

data/commands/build/support/generate-commit-message.rb

@@ -5,13 +5,13 @@ def word_wrap(text)
 end
 
 def collect_issues
-  out = `git log $(git describe --tags --abbrev=0)...HEAD -E --grep '#[0-9]+' 2>/dev/null`
+  out = `git log $(git describe --tags --abbrev=0)...HEAD -E --grep '#[0-9]+' 2>#{ENV['__DEVNULL']}`
   issues = out.scan(/((?:\S+\/\S+)?#\d+)/).flatten
 end
 
-message = ENV["_message"]
+message = ENV["_MESSAGE"]
 if message.nil? || message.strip.empty?
-  message = "Tag release v#{ENV["_version"]}"
+  message = "Tag release v#{ENV["_VERSION"]}"
 
   issues = collect_issues
   if issues.size > 0

data/commands/publish/cf-invalidate

@@ -1,7 +1,7 @@
 #!/bin/sh
 
-export AWS_ACCESS_KEY_ID=$__creds_key
-export AWS_SECRET_ACCESS_KEY=$__creds_secret
+export AWS_ACCESS_KEY_ID=$__CREDS_KEY
+export AWS_SECRET_ACCESS_KEY=$__CREDS_SECRET
 
 qty="$#"
 items=`python -c 'import sys, json; print json.dumps(sys.argv[1:])' $*`
@@ -9,6 +9,6 @@ ref=`date`
 
 aws configure set preview.cloudfront true
 aws cloudfront create-invalidation \
-  --region $_region \
-  --distribution-id $_distribution \
+  --region $_REGION \
+  --distribution-id $_DISTRIBUTION \
   --invalidation-batch "{\"Paths\":{\"Quantity\":$qty,\"Items\":$items},\"CallerReference\":\"$ref\"}"

data/commands/publish/gem-push

@@ -2,6 +2,6 @@
 
 curl --fail --silent -X POST \
   -H "Content-Type: application/octet-stream" \
-  -H "Authorization: $__creds_secret" \
+  -H "Authorization: $__CREDS_SECRET" \
   --data-binary @$* https://rubygems.org/api/v1/gems
 echo ""

data/commands/publish/git-push

@@ -14,11 +14,11 @@ esac
 
 cd $dir
 echo "-----BEGIN RSA PRIVATE KEY-----" > .sshkey
-echo "$__creds_key" | fold -w 65 >> .sshkey
+echo "$__CREDS_KEY" | fold -w 65 >> .sshkey
 echo "-----END RSA PRIVATE KEY-----" >> .sshkey
 chmod 400 .sshkey
 
-for r in $_remotes; do
-  ssh-agent sh -c "ssh-add .sshkey; git push $r $_refs"
+for r in $_REMOTES; do
+  ssh-agent sh -c "ssh-add .sshkey; git push $r $_REFS"
 done
 cd $olddir

data/commands/publish/github-release

@@ -36,12 +36,12 @@ def https_request(opts = {})
   end
 end
 
-key = ENV["__creds_secret"]
-repository = ENV["_repository"]
+key = ENV["__CREDS_SECRET"]
+repository = ENV["_REPOSITORY"]
 tag = ENV["_tag"]
-changelog = ENV["_changelog"]
-title = ENV["_title"] || "Release #{tag}"
-out_file = ENV["_out_file"]
+changelog = ENV["_CHANGELOG"]
+title = ENV["_TITLE"] || "Release #{tag}"
+out_file = ENV["_OUT_FILE"]
 assets = ARGV
 
 fail "Missing `repository`" unless repository

data/commands/publish/npm-publish

@@ -1,3 +1,3 @@
 #!/bin/sh
 
-npm publish --email=$__creds_key --_auth=$__creds_secret ./$*
+npm publish --email=$__CREDS_KEY --_auth=$__CREDS_SECRET ./$*

data/commands/publish/s3-put

@@ -1,7 +1,7 @@
 #!/bin/sh
 
-export AWS_ACCESS_KEY_ID=$__creds_key
-export AWS_SECRET_ACCESS_KEY=$__creds_secret
+export AWS_ACCESS_KEY_ID=$__CREDS_KEY
+export AWS_SECRET_ACCESS_KEY=$__CREDS_SECRET
 
 set -e
 for f in $*; do
@@ -9,5 +9,5 @@ for f in $*; do
   if [ -d $f ]; then
     recursive="--recursive"
   fi
-  aws s3 cp $recursive --acl public-read --region $_region $f s3://$_bucket/$_prefix$_key
+  aws s3 cp $recursive --acl public-read --region $_REGION $f s3://$_BUCKET/$_PREFIX$_KEY
 done

data/lib/samus.rb

@@ -31,6 +31,10 @@ module Samus
     puts "[E] #{msg}"
     exit(1)
   end
+
+  def windows?
+    ::RbConfig::CONFIG['host_os'] =~ /mingw|win32|cygwin/ ? true : false
+  end
 end
 
 Samus.load_configuration_directory

data/lib/samus/builder.rb

@@ -27,20 +27,21 @@ module Samus
       build_branch = "samus-release/v#{version}"
       orig_branch = `git symbolic-ref -q --short HEAD`.chomp
 
-      if `git diff --shortstat 2> /dev/null | tail -n1` != ''
+      if `git diff --shortstat 2> #{devnull} | tail -n1` != ''
         Samus.error 'Repository is dirty, it is too dangerous to continue.'
       end
 
-      system "git checkout -qb #{build_branch} 2>/dev/null"
+      system "git checkout -qb #{build_branch} 2>#{devnull}"
       remove_restore_file
 
       Dir.mktmpdir do |build_dir|
         actions.map do |action|
           BuildAction.new(dry_run: dry_run, arguments: {
-                            '_restore_file' => RESTORE_FILE,
-                            '_build_dir' => build_dir,
-                            '_build_branch' => build_branch,
-                            'version' => version
+                            '_RESTORE_FILE' => RESTORE_FILE,
+                            '_BUILD_DIR' => build_dir,
+                            '_BUILD_BRANCH' => build_branch,
+                            '_DEVNULL' => devnull,
+                            'VERSION' => version
                           }).load(action)
         end.each do |action|
           next if action.skip
@@ -57,8 +58,8 @@ module Samus
       end
     ensure
       restore_git_repo
-      system "git checkout -q #{orig_branch} 2>/dev/null"
-      system "git branch -qD #{build_branch} 2>/dev/null"
+      system "git checkout -q #{orig_branch} 2>#{devnull}"
+      system "git branch -qD #{build_branch} 2>#{devnull}"
     end
 
     private
@@ -75,10 +76,11 @@ module Samus
       file_is_zipped = file =~ /\.(tar\.gz|tgz)$/
       if zip_release || file_is_zipped
         file += '.tar.gz' unless file_is_zipped
-        system "tar cfz #{file} *"
+        system "tar cfz #{file.inspect} *"
       else
-        system "mkdir -p #{file} && cp -r * #{file}"
+        system "mkdir #{file.inspect} && cp -R * #{file.inspect}"
       end
+      Samus.error "Failed to build release package" if $?.to_i != 0
       puts "[I] Built release package: #{File.basename(file)}"
     end
 
@@ -94,7 +96,7 @@ module Samus
         case type
         when 'tag'
           puts "[D] Removing tag #{branch}" if $DEBUG
-          system "git tag -d #{branch} >/dev/null"
+          system "git tag -d #{branch} >#{devnull}"
         when 'branch'
           puts "[D] Restoring #{branch} to #{commit}" if $DEBUG
           system "git checkout -q #{branch}"
@@ -112,5 +114,9 @@ module Samus
     def version
       self.class.build_version
     end
+
+    def devnull
+      Samus.windows? ? 'NUL' : '/dev/null'
+    end
   end
 end

data/lib/samus/command.rb

@@ -67,7 +67,7 @@ module Samus
     end
 
     def run(opts = {})
-      env = (opts[:arguments] || {}).each_with_object({}) { |(k, v), h| h["_#{k}"] = v; }
+      env = (opts[:arguments] || {}).each_with_object({}) { |(k, v), h| h["_#{k.upcase}"] = v; }
       arguments = opts[:files] || []
       dry_run = opts[:dry_run] || false
       allow_fail = opts[:allow_fail] || false
@@ -77,9 +77,9 @@ module Samus
 
       return if dry_run
       exec_in_dir(pwd) do
-        system(env, @full_path + ' ' + (arguments ? arguments.join(' ') : ''))
+        system(env, exe_type + @full_path + ' ' + (arguments ? arguments.join(' ') : ''))
       end
-      report_error($CHILD_STATUS, allow_fail)
+      report_error($?, allow_fail)
     end
 
     def <=>(other)
@@ -98,6 +98,21 @@ module Samus
       dir ? Dir.chdir(dir, &block) : yield
     end
 
+    def exe_type
+      return '' unless Samus.windows?
+
+      if File.readlines(@full_path).first.chomp =~ /^#!(.+)/
+        path = $1
+        if path == '/bin/sh'
+          'sh '
+        elsif path == '/usr/bin/env ruby'
+          'ruby '
+        else
+          path + ' '
+        end
+      end
+    end
+
     def load_full_path
       path = self.class.command_paths.find do |ipath|
         File.exist?(File.join(ipath, stage, name))

data/lib/samus/credentials.rb

@@ -29,6 +29,10 @@ module Samus
 
       data.split(/\r?\n/).each do |line|
         name, value = *line.strip.split(':')
+        if value.nil?
+          Samus.error "Failed to parse credential from #{@file} (exec bit: #{File.executable?(@file)})"
+        end
+
         hsh["_creds_#{name.strip.downcase}"] = value.strip
       end
 

data/lib/samus/publisher.rb

@@ -14,7 +14,7 @@ module Samus
         actions.map do |action|
           PublishAction.new(
             dry_run: dry_run,
-            arguments: { 'version' => manifest['version'] }
+            arguments: { 'VERSION' => manifest['version'] }
           ).load(action)
         end.each(&:run)
       end

data/lib/samus/version.rb

@@ -1,3 +1,3 @@
-module Samus
-  VERSION = '1.6.3'.freeze
-end
+module Samus
+  VERSION = '2.0.0'.freeze
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: samus
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-20 00:00:00.000000000 Z
+date: 2018-08-09 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: lsegal@soen.ca
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Samus helps you release Open Source Software.