capsulecd 1.0.0

data/lib/capsulecd/javascript/javascript_engine.rb

@@ -0,0 +1,213 @@
+require 'semverly'
+require 'open3'
+require 'bundler'
+require 'json'
+require_relative '../base/engine'
+
+module CapsuleCD
+  module Javascript
+    class JavascriptEngine < Engine
+      def build_step
+        super
+
+        @_is_bower = File.exist?(@source_git_local_path + '/bower.json')
+        @_is_npm = File.exist?(@source_git_local_path + '/package.json')
+
+        # validate that the metadata files exist
+        if !@_is_bower && !@_is_npm
+          fail CapsuleCD::Error::BuildPackageInvalid, 'package.json or bower.json file must be present for Javascript packages'
+        end
+
+        # we can't bump the npm version here because the npm version patch command will set it.
+        # howerver we need to make sure the bower.json and package.json versions are insync.
+        # we'll take the latest version of either the package.json or bower.json and set that as the version of both.
+        sync_versions
+
+        # now that the bower and package versions are in sync, lets bump the version of bower.json
+        # (because package.json will be bumped automatically.)
+        if @_is_bower
+          bower_file = File.read(@source_git_local_path + '/bower.json')
+          bower_data = JSON.parse(bower_file)
+          next_version = bump_version(SemVer.parse(bower_data['version']))
+          bower_data['version'] = next_version.to_s
+          File.write(@source_git_local_path + '/bower.json', JSON.pretty_generate(bower_data))
+        end
+
+
+        # TODO: check if this module name and version already exist.
+
+        # check for/create any required missing folders/files
+        unless File.exist?(@source_git_local_path + '/test')
+          FileUtils.mkdir(@source_git_local_path + '/test')
+        end
+        unless File.exist?(@source_git_local_path + '/.gitignore')
+          CapsuleCD::GitUtils.create_gitignore(@source_git_local_path, ['Node','Yeoman'])
+        end
+      end
+
+      def test_step
+        super
+
+        if @_is_npm
+          # the module has already been downloaded. lets make sure all its dependencies are available.
+          Open3.popen3('npm install', chdir: @source_git_local_path) do |_stdin, stdout, stderr, external|
+            { stdout: stdout, stderr: stderr }. each do |name, stream_buffer|
+              Thread.new do
+                until (line = stream_buffer.gets).nil?
+                  puts "#{name} -> #{line}"
+                end
+              end
+            end
+            # wait for process
+            external.join
+            unless external.value.success?
+              fail CapsuleCD::Error::TestDependenciesError, 'npm install failed. Check module dependencies'
+            end
+          end
+          # create a shrinkwrap file.
+          Open3.popen3('npm shrinkwrap', chdir: @source_git_local_path) do |_stdin, stdout, stderr, external|
+            { stdout: stdout, stderr: stderr }. each do |name, stream_buffer|
+              Thread.new do
+                until (line = stream_buffer.gets).nil?
+                  puts "#{name} -> #{line}"
+                end
+              end
+            end
+            # wait for process
+            external.join
+            unless external.value.success?
+              fail CapsuleCD::Error::TestDependenciesError, 'npm shrinkwrap failed. Check log for exact error'
+            end
+          end
+
+          # run test command
+          test_cmd = @config.engine_cmd_test || 'npm test'
+          Open3.popen3(ENV, test_cmd, chdir: @source_git_local_path) do |_stdin, stdout, stderr, external|
+            { stdout: stdout, stderr: stderr }. each do |name, stream_buffer|
+              Thread.new do
+                until (line = stream_buffer.gets).nil?
+                  puts "#{name} -> #{line}"
+                end
+              end
+            end
+            # wait for process
+            external.join
+            unless external.value.success?
+              fail CapsuleCD::Error::TestRunnerError, test_cmd + ' failed. Check log for exact error'
+            end
+          end unless @config.engine_disable_test
+        end
+
+        if @_is_bower
+          # lets make sure all the bower dependencies are available.
+          Open3.popen3('bower install --allow-root', chdir: @source_git_local_path) do |_stdin, stdout, stderr, external|
+            { stdout: stdout, stderr: stderr }. each do |name, stream_buffer|
+              Thread.new do
+                until (line = stream_buffer.gets).nil?
+                  puts "#{name} -> #{line}"
+                end
+              end
+            end
+            # wait for process
+            external.join
+            unless external.value.success?
+              fail CapsuleCD::Error::TestDependenciesError, 'npm install failed. Check module dependencies'
+            end
+          end
+        end
+      end
+
+      # run npm publish
+      def package_step
+        super
+
+        # commit changes to the cookbook. (test run occurs before this, and it should clean up any instrumentation files, created,
+        # as they will be included in the commmit and any release artifacts)
+        CapsuleCD::GitUtils.commit(@source_git_local_path, 'Committing automated changes before packaging.') rescue puts 'No changes to commit..'
+        if @_is_bower && !@_is_npm
+          bower_file = File.read(@source_git_local_path + '/bower.json')
+          bower_data = JSON.parse(bower_file)
+          next_version = SemVer.parse(bower_data['version'])
+          @source_release_commit = CapsuleCD::GitUtils.tag(@source_git_local_path, "v#{next_version}")
+
+        else
+
+          # run npm publish
+          Open3.popen3("npm version #{@config.engine_version_bump_type} -m '(v%s) Automated packaging of release by CapsuleCD'", chdir: @source_git_local_path) do |_stdin, stdout, stderr, external|
+            { stdout: stdout, stderr: stderr }. each do |name, stream_buffer|
+              Thread.new do
+                until (line = stream_buffer.gets).nil?
+                  puts "#{name} -> #{line}"
+                end
+              end
+            end
+            # wait for process
+            external.join
+            fail 'npm version bump failed' unless external.value.success?
+          end
+          @source_release_commit = CapsuleCD::GitUtils.get_latest_tag_commit(@source_git_local_path)
+        end
+
+
+      end
+
+      # this step should push the release to the package repository (ie. npm, chef supermarket, rubygems)
+      def release_step
+        super
+
+        if @_is_npm
+          npmrc_path = File.expand_path('~/.npmrc')
+
+          unless @config.npm_auth_token
+            fail CapsuleCD::Error::ReleaseCredentialsMissing, 'cannot deploy page to npm, credentials missing'
+            return
+          end
+
+          # write the knife.rb config file.
+          File.open(npmrc_path, 'w+') do |file|
+            file.write("//registry.npmjs.org/:_authToken=#{@config.npm_auth_token}")
+          end
+
+          # run npm publish
+          Open3.popen3('npm publish .', chdir: @source_git_local_path) do |_stdin, stdout, stderr, external|
+            { stdout: stdout, stderr: stderr }. each do |name, stream_buffer|
+              Thread.new do
+                until (line = stream_buffer.gets).nil?
+                  puts "#{name} -> #{line}"
+                end
+              end
+            end
+            # wait for process
+            external.join
+            unless external.value.success?
+              fail CapsuleCD::Error::ReleasePackageError, 'npm publish failed. Check log for exact error'
+            end
+          end
+        end
+      end
+
+      private
+      def sync_versions
+        #this method only needs to run if bower and package json files exist.
+        if !@_is_bower || !@_is_npm
+          return
+        end
+
+        bower_file = File.read(@source_git_local_path + '/bower.json')
+        bower_data = JSON.parse(bower_file)
+        bower_version = SemVer.parse(bower_data['version'])
+        package_file = File.read(@source_git_local_path + '/package.json')
+        package_data = JSON.parse(package_file)
+        package_version = SemVer.parse(package_data['version'])
+
+        if(bower_version>package_version)
+          package_data['version'] = bower_version.to_s
+          File.write(@source_git_local_path + '/package.json', JSON.pretty_generate(package_data))
+        else
+          bower_data['version'] = package_version.to_s
+          File.write(@source_git_local_path + '/bower.json', JSON.pretty_generate(bower_data))
+        end
+      end
+    end
+  end
+end

data/lib/capsulecd/node/node_engine.rb

@@ -0,0 +1,141 @@
+require 'semverly'
+require 'open3'
+require 'bundler'
+require_relative '../base/engine'
+
+module CapsuleCD
+  module Node
+    class NodeEngine < Engine
+      def build_step
+        super
+        # validate that the chef metadata.rb file exists
+        unless File.exist?(@source_git_local_path + '/package.json')
+          fail CapsuleCD::Error::BuildPackageInvalid, 'package.json file is required to process Npm package'
+        end
+
+        # no need to bump up the version here. It will automatically be bumped up via the npm version patch command.
+        # however we need to read the version from the package.json file and check if a npm module already exists.
+
+        # TODO: check if this module name and version already exist.
+
+        # check for/create any required missing folders/files
+        unless File.exist?(@source_git_local_path + '/test')
+          FileUtils.mkdir(@source_git_local_path + '/test')
+        end
+        unless File.exist?(@source_git_local_path + '/.gitignore')
+          CapsuleCD::GitUtils.create_gitignore(@source_git_local_path, ['Node'])
+        end
+      end
+
+      def test_step
+        super
+
+        # the module has already been downloaded. lets make sure all its dependencies are available.
+        Open3.popen3('npm install', chdir: @source_git_local_path) do |_stdin, stdout, stderr, external|
+          { stdout: stdout, stderr: stderr }. each do |name, stream_buffer|
+            Thread.new do
+              until (line = stream_buffer.gets).nil?
+                puts "#{name} -> #{line}"
+              end
+            end
+          end
+          # wait for process
+          external.join
+          unless external.value.success?
+            fail CapsuleCD::Error::TestDependenciesError, 'npm install failed. Check module dependencies'
+          end
+        end
+
+        # create a shrinkwrap file.
+        Open3.popen3('npm shrinkwrap', chdir: @source_git_local_path) do |_stdin, stdout, stderr, external|
+          { stdout: stdout, stderr: stderr }. each do |name, stream_buffer|
+            Thread.new do
+              until (line = stream_buffer.gets).nil?
+                puts "#{name} -> #{line}"
+              end
+            end
+          end
+          # wait for process
+          external.join
+          unless external.value.success?
+            fail CapsuleCD::Error::TestDependenciesError, 'npm shrinkwrap failed. Check log for exact error'
+          end
+        end
+
+        # run test command
+        test_cmd = @config.engine_cmd_test || 'npm test'
+        Open3.popen3(ENV, test_cmd, chdir: @source_git_local_path) do |_stdin, stdout, stderr, external|
+          { stdout: stdout, stderr: stderr }. each do |name, stream_buffer|
+            Thread.new do
+              until (line = stream_buffer.gets).nil?
+                puts "#{name} -> #{line}"
+              end
+            end
+          end
+          # wait for process
+          external.join
+          unless external.value.success?
+            fail CapsuleCD::Error::TestRunnerError, test_cmd + ' failed. Check log for exact error'
+          end
+        end unless @config.engine_disable_test
+      end
+
+      # run npm publish
+      def package_step
+        super
+
+        # commit changes to the cookbook. (test run occurs before this, and it should clean up any instrumentation files, created,
+        # as they will be included in the commmit and any release artifacts)
+        CapsuleCD::GitUtils.commit(@source_git_local_path, 'Committing automated changes before packaging.') rescue puts 'No changes to commit..'
+
+        # run npm publish
+        Open3.popen3("npm version #{@config.engine_version_bump_type} -m '(v%s) Automated packaging of release by CapsuleCD'", chdir: @source_git_local_path) do |_stdin, stdout, stderr, external|
+          { stdout: stdout, stderr: stderr }. each do |name, stream_buffer|
+            Thread.new do
+              until (line = stream_buffer.gets).nil?
+                puts "#{name} -> #{line}"
+              end
+            end
+          end
+          # wait for process
+          external.join
+          fail 'npm version bump failed' unless external.value.success?
+        end
+
+        @source_release_commit = CapsuleCD::GitUtils.get_latest_tag_commit(@source_git_local_path)
+      end
+
+      # this step should push the release to the package repository (ie. npm, chef supermarket, rubygems)
+      def release_step
+        super
+        npmrc_path = File.expand_path('~/.npmrc')
+
+        unless @config.npm_auth_token
+          fail CapsuleCD::Error::ReleaseCredentialsMissing, 'cannot deploy page to npm, credentials missing'
+          return
+        end
+
+        # write the knife.rb config file.
+        File.open(npmrc_path, 'w+') do |file|
+          file.write("//registry.npmjs.org/:_authToken=#{@config.npm_auth_token}")
+        end
+
+        # run npm publish
+        Open3.popen3('npm publish .', chdir: @source_git_local_path) do |_stdin, stdout, stderr, external|
+          { stdout: stdout, stderr: stderr }. each do |name, stream_buffer|
+            Thread.new do
+              until (line = stream_buffer.gets).nil?
+                puts "#{name} -> #{line}"
+              end
+            end
+          end
+          # wait for process
+          external.join
+          unless external.value.success?
+            fail CapsuleCD::Error::ReleasePackageError, 'npm publish failed. Check log for exact error'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capsulecd/python/python_engine.rb

@@ -0,0 +1,157 @@
+require 'semverly'
+require 'open3'
+require 'bundler'
+require_relative '../base/engine'
+
+module CapsuleCD
+  module Python
+    class PythonEngine < Engine
+      def build_step
+        super
+        unless File.exist?(@source_git_local_path + '/setup.py')
+          fail CapsuleCD::Error::BuildPackageInvalid, 'setup.py file is required to process Python package'
+        end
+
+        # check for/create required VERSION file
+        unless File.exist?(@source_git_local_path + '/VERSION')
+          File.open(@source_git_local_path + '/VERSION', 'w') { |file| file.write('0.0.0') }
+        end
+
+        # bump up the version here.
+        # since there's no standardized way to bump up the version in the setup.py file, we're going to assume that the version
+        # is specified in a VERSION file in the root of the source repository
+        # this is option #4 in the python packaging guide:
+        # https://packaging.python.org/en/latest/single_source_version/#single-sourcing-the-version
+        #
+        # additional packaging structures, like those listed below, may also be supported in the future.
+        # http://stackoverflow.com/a/7071358/1157633
+
+        version = File.read(@source_git_local_path + '/VERSION').strip
+        next_version = bump_version(SemVer.parse(version))
+        File.open(@source_git_local_path + '/VERSION', 'w') do |file|
+          file.write(next_version)
+        end
+
+        # make sure the package testing manager is available.
+        # there is a standardized way to test packages (python setup.py tests), however for automation tox is preferred
+        # because of virtualenv and its support for multiple interpreters.
+        unless File.exist?(@source_git_local_path + '/tox.ini')
+          # if a tox.ini file is not present, we'll create a default one and specify 'python setup.py test' as the test
+          # runner command, and requirements.txt as the dependencies for this package.
+          File.open(@source_git_local_path + '/tox.ini', 'w') { |file|
+            file.write(<<-TOX.gsub(/^\s+/, '')
+# Tox (http://tox.testrun.org/) is a tool for running tests
+# in multiple virtualenvs. This configuration file will run the
+# test suite on all supported python versions. To use it, "pip install tox"
+# and then run "tox" from this directory.
+
+[tox]
+envlist = py27
+usedevelop = True
+
+[testenv]
+commands = python setup.py test
+deps =
+  -rrequirements.txt
+TOX
+            )
+          }
+        end
+
+        # check for/create any required missing folders/files
+        unless File.exist?(@source_git_local_path + '/requirements.txt')
+          File.open(@source_git_local_path + '/requirements.txt', 'w') { |file| file.write('') }
+        end
+
+        unless File.exist?(@source_git_local_path + '/tests')
+          FileUtils.mkdir(@source_git_local_path + '/tests')
+        end
+        unless File.exist?(@source_git_local_path + '/tests/__init__.py')
+          File.open(@source_git_local_path + '/tests/__init__.py', 'w') { |file| file.write('') }
+        end
+        unless File.exist?(@source_git_local_path + '/.gitignore')
+          CapsuleCD::GitUtils.create_gitignore(@source_git_local_path, ['Python'])
+        end
+      end
+
+      def test_step
+        super
+
+
+        # download the package dependencies and register it in the virtualenv using tox (which will do pip install -e .)
+        # https://packaging.python.org/en/latest/distributing/
+        # once that's done, tox will run tests
+        # run test command
+        test_cmd = @config.engine_cmd_test || 'tox'
+        Open3.popen3(test_cmd, chdir: @source_git_local_path) do |_stdin, stdout, stderr, external|
+          { stdout: stdout, stderr: stderr }. each do |name, stream_buffer|
+            Thread.new do
+              until (line = stream_buffer.gets).nil?
+                puts "#{name} -> #{line}"
+              end
+            end
+          end
+          # wait for process
+          external.join
+          unless external.value.success?
+            fail CapsuleCD::Error::TestDependenciesError, test_cmd + ' failed to test package.'
+          end
+        end unless @config.engine_disable_test
+      end
+
+      # run npm publish
+      def package_step
+        super
+
+        # commit changes to the cookbook. (test run occurs before this, and it should clean up any instrumentation files, created,
+        # as they will be included in the commmit and any release artifacts)
+        version = File.read(@source_git_local_path + '/VERSION').strip
+        next_version = SemVer.parse(version)
+        CapsuleCD::GitUtils.commit(@source_git_local_path, "(v#{next_version}) Automated packaging of release by CapsuleCD")
+        @source_release_commit = CapsuleCD::GitUtils.tag(@source_git_local_path, "v#{next_version}")
+      end
+
+      # this step should push the release to the package repository (ie. npm, chef supermarket, rubygems)
+      def release_step
+        super
+        pypirc_path = File.expand_path('~/.pypirc')
+
+        unless @config.pypi_username || @config.pypi_password
+          fail CapsuleCD::Error::ReleaseCredentialsMissing, 'cannot deploy package to pip, credentials missing'
+          return
+        end
+
+        # write the knife.rb config file.
+        File.open(pypirc_path, 'w+') do |file|
+          file.write(<<-EOT.gsub(/^\s+/, '')
+            [distutils]
+            index-servers=pypi
+
+            [pypi]
+            repository = https://pypi.python.org/pypi
+            username = #{@config.pypi_username}
+            password = #{@config.pypi_password}
+          EOT
+                    )
+        end
+
+        # run python setup.py sdist upload
+        # TODO: use twine instead (it supports HTTPS.)https://python-packaging-user-guide.readthedocs.org/en/latest/distributing/#uploading-your-project-to-pypi
+        Open3.popen3('python setup.py sdist upload', chdir: @source_git_local_path) do |_stdin, stdout, stderr, external|
+          { stdout: stdout, stderr: stderr }. each do |name, stream_buffer|
+            Thread.new do
+              until (line = stream_buffer.gets).nil?
+                puts "#{name} -> #{line}"
+              end
+            end
+          end
+          # wait for process
+          external.join
+          unless external.value.success?
+            fail CapsuleCD::Error::ReleasePackageError, 'python setup.py upload failed. Check log for exact error'
+          end
+        end
+      end
+    end
+  end
+end