poise-javascript 1.0.0

data/lib/poise_javascript/javascript_providers/nodejs.rb

@@ -0,0 +1,64 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/resource'
+require 'poise_languages/static'
+
+require 'poise_javascript/error'
+require 'poise_javascript/javascript_providers/base'
+
+
+module PoiseJavascript
+  module JavascriptProviders
+    class NodeJS < Base
+      provides(:nodejs)
+      include PoiseLanguages::Static(
+        versions: %w{4.1.1 4.0.0 0.12.7 0.11.16 0.10.40 0.9.12 0.8.28 0.7.12 0.6.21 0.5.10},
+        machines: %w{linux-i686 linux-x86_64 darwin-x86_64},
+        url: 'https://nodejs.org/dist/v%{version}/node-v%{version}-%{kernel}-%{machine}.tar.gz',
+      )
+
+      def self.provides_auto?(node, resource)
+        # Also work if we have a blank or numeric-y version. This should make
+        # it the default provider on supported platforms.
+        super || (resource.version.to_s =~ /^(\d|$)/ && static_machines.include?(static_machine_label(node)))
+      end
+
+      MACHINE_LABELS = {'i386' => 'x86', 'i686' => 'x86', 'x86_64' => 'x64'}
+
+      def static_url_variables
+        machine = node['kernel']['machine']
+        super.merge(machine: MACHINE_LABELS[machine] || machine)
+      end
+
+      def javascript_binary
+        ::File.join(static_folder, 'bin', 'node')
+      end
+
+      private
+
+      def install_javascript
+        install_static
+      end
+
+      def uninstall_javascript
+        uninstall_static
+      end
+
+    end
+  end
+end
+

data/lib/poise_javascript/javascript_providers/scl.rb

@@ -0,0 +1,79 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/resource'
+require 'poise_languages'
+
+require 'poise_javascript/error'
+require 'poise_javascript/javascript_providers/base'
+
+
+module PoiseJavascript
+  module JavascriptProviders
+    class Scl < Base
+      include PoiseLanguages::Scl::Mixin
+      provides(:scl)
+      scl_package('0.10.35', 'nodejs010', 'nodejs010-nodejs-devel', {
+        ['redhat', 'centos'] => {
+          '~> 7.0' => 'https://www.softwarecollections.org/en/scls/rhscl/nodejs010/epel-7-x86_64/download/rhscl-nodejs010-epel-7-x86_64.noarch.rpm',
+          '~> 6.0' => 'https://www.softwarecollections.org/en/scls/rhscl/nodejs010/epel-6-x86_64/download/rhscl-nodejs010-epel-6-x86_64.noarch.rpm',
+        },
+      })
+
+      V8_SCL_URLS = {
+        ['redhat', 'centos'] => {
+          '~> 7.0' => 'https://www.softwarecollections.org/en/scls/rhscl/v8314/epel-7-x86_64/download/rhscl-v8314-epel-7-x86_64.noarch.rpm',
+          '~> 6.0' => 'https://www.softwarecollections.org/en/scls/rhscl/v8314/epel-6-x86_64/download/rhscl-v8314-epel-6-x86_64.noarch.rpm',
+        },
+      }
+
+      def javascript_binary
+        ::File.join(scl_folder, 'root', 'usr', 'bin', 'node')
+      end
+
+      def javascript_environment
+        scl_environment
+      end
+
+      private
+
+      def install_javascript
+        install_v8_scl_package
+        install_scl_package
+      end
+
+      def uninstall_javascript
+        uninstall_scl_package
+        uninstall_v8_scl_package
+      end
+
+      def install_v8_scl_package
+        poise_languages_scl 'v8314' do
+          parent new_resource
+          url node.value_for_platform(V8_SCL_URLS)
+        end
+      end
+
+      def uninstall_v8_scl_package
+        install_v8_scl_package.tap do |r|
+          r.action(:uninstall)
+        end
+      end
+
+    end
+  end
+end
+

data/lib/poise_javascript/javascript_providers/system.rb

@@ -0,0 +1,71 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/resource'
+require 'poise_languages'
+
+require 'poise_javascript/error'
+require 'poise_javascript/javascript_providers/base'
+
+
+module PoiseJavascript
+  module JavascriptProviders
+    class System < Base
+      include PoiseLanguages::System::Mixin
+      provides(:system)
+      packages('nodejs', {
+        debian: {default: %w{nodejs}},
+        ubuntu: {default: %w{nodejs}},
+        # Empty arrays because no package in the base OS.
+        redhat: {default: %w{}},
+        centos: {default: %w{}},
+        fedora: {default: %w{nodejs}},
+        amazon: {default: %w{}},
+      })
+
+      def self.provides_auto?(node, resource)
+        # Don't auto on platforms I know have no system package by default. Kind
+        # of pointless since the nodejs provider will hit on these platforms
+        # anyway so this shouldn't ever happen.
+        super && !node.platform_family?('rhel') && !node.platform?('amazon')
+      end
+
+      def javascript_binary
+        # Debian and Ubuntu after 12.04 changed the binary name ಠ_ಠ.
+        binary_name = node.value_for_platform(debian: {default: 'nodejs'}, ubuntu: {'12.04' => 'node', default: 'nodejs'}, default: 'node')
+        ::File.join('', 'usr', 'bin', binary_name)
+      end
+
+      private
+
+      def install_javascript
+        install_system_packages
+        package %w{npm nodejs-legacy} if node.platform_family?('debian')
+      end
+
+      def uninstall_javascript
+        uninstall_system_packages
+        package(%w{npm nodejs-legacy}) { action :purge } if node.platform_family?('debian')
+      end
+
+      def system_package_candidates(version)
+        # Boring :-(.
+        %w{nodejs nodejs-legacy node}
+      end
+
+    end
+  end
+end

data/lib/poise_javascript/resources.rb

@@ -0,0 +1,29 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'poise_javascript/resources/javascript_execute'
+require 'poise_javascript/resources/javascript_runtime'
+require 'poise_javascript/resources/node_package'
+require 'poise_javascript/resources/npm_install'
+
+
+module PoiseJavascript
+  # Chef resources and providers for poise-javascript.
+  #
+  # @since 1.0.0
+  module Resources
+  end
+end

data/lib/poise_javascript/resources/javascript_execute.rb

@@ -0,0 +1,83 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/mixin/which'
+require 'chef/provider/execute'
+require 'chef/resource/execute'
+require 'poise'
+
+require 'poise_javascript/javascript_command_mixin'
+
+
+module PoiseJavascript
+  module Resources
+    # (see JavascriptExecute::Resource)
+    # @since 1.0.0
+    module JavascriptExecute
+      # A `javascript_execute` resource to run Javascript scripts and commands.
+      #
+      # @provides javascript_execute
+      # @action run
+      # @example
+      #   javascript_execute 'myapp.js' do
+      #     user 'myuser'
+      #   end
+      class Resource < Chef::Resource::Execute
+        include PoiseJavascript::JavascriptCommandMixin
+        provides(:javascript_execute)
+        actions(:run)
+      end
+
+      # The default provider for `javascript_execute`.
+      #
+      # @see Resource
+      # @provides javascript_execute
+      class Provider < Chef::Provider::Execute
+        include Chef::Mixin::Which
+        provides(:javascript_execute)
+
+        private
+
+        # Command to pass to shell_out.
+        #
+        # @return [String, Array<String>]
+        def command
+          if new_resource.command.is_a?(Array)
+            [new_resource.javascript] + new_resource.command
+          else
+            "#{new_resource.javascript} #{new_resource.command}"
+          end
+        end
+
+        # Environment variables to pass to shell_out.
+        #
+        # @return [Hash]
+        def environment
+          if new_resource.parent_javascript
+            environment = new_resource.parent_javascript.javascript_environment
+            if new_resource.environment
+              environment = environment.merge(new_resource.environment)
+            end
+            environment
+          else
+            new_resource.environment
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/poise_javascript/resources/javascript_runtime.rb

@@ -0,0 +1,85 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/resource'
+require 'poise'
+
+
+module PoiseJavascript
+  module Resources
+    # (see JavascriptRuntime::Resource)
+    # @since 1.0.0
+    module JavascriptRuntime
+      # A `javascript_runtime` resource to manage Javascript installations.
+      #
+      # @provides javascript_runtime
+      # @action install
+      # @action uninstall
+      # @example
+      #   javascript_runtime '2.7'
+      class Resource < Chef::Resource
+        include Poise(inversion: true, container: true)
+        provides(:javascript_runtime)
+        actions(:install, :uninstall)
+
+        # @!attribute version
+        #   Version of Javascript to install. This is generally a NodeJS version
+        #   but because of io.js there are shenanigans.
+        #   @return [String]
+        #   @example Install any version
+        #     javascript_runtime 'any' do
+        #       version ''
+        #     end
+        attribute(:version, kind_of: String, name_attribute: true)
+
+        # The path to the `node` binary for this Javascript installation. This is
+        # an output property.
+        #
+        # @return [String]
+        # @example
+        #   execute "#{resources('javascript_runtime[nodejs]').javascript_binary} myapp.js"
+        def javascript_binary
+          provider_for_action(:javascript_binary).javascript_binary
+        end
+
+        # The environment variables for this Javascript installation. This is an
+        # output property.
+        #
+        # @return [Hash<String, String>]
+        # @example
+        #   execute '/opt/myapp.js' do
+        #     environment resources('javascript_runtime[nodejs]').javascript_environment
+        #   end
+        def javascript_environment
+          provider_for_action(:javascript_environment).javascript_environment
+        end
+
+        # The path to the `npm` binary for this Javascript installation. This is
+        # an output property. Can raise an exception if NPM is not supported for
+        # this runtime.
+        #
+        # @return [String]
+        # @example
+        #   execute "#{resources('javascript_runtime[nodejs]').npm_binary} install"
+        def npm_binary
+          provider_for_action(:npm_binary).npm_binary
+        end
+      end
+
+      # Providers can be found under lib/poise_javascript/javascript_providers/
+    end
+  end
+end

data/lib/poise_javascript/resources/javascript_runtime_test.rb

@@ -0,0 +1,226 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/provider'
+require 'chef/resource'
+require 'poise'
+
+
+module PoiseJavascript
+  module Resources
+    # (see JavascriptRuntimeTest::Resource)
+    # @since 1.0.0
+    # @api private
+    module JavascriptRuntimeTest
+      # A `javascript_runtime_test` resource for integration testing of this
+      # cookbook. This is an internal API and can change at any time.
+      #
+      # @provides javascript_runtime_test
+      # @action run
+      class Resource < Chef::Resource
+        include Poise
+        provides(:javascript_runtime_test)
+        actions(:run)
+
+        attribute(:version, kind_of: String, name_attribute: true)
+        attribute(:runtime_provider, kind_of: Symbol)
+        attribute(:path, kind_of: String, default: lazy { default_path })
+        attribute(:test_yo, equal_to: [true, false], default: true)
+
+        def default_path
+          ::File.join('', 'root', "javascript_test_#{name}")
+        end
+      end
+
+      # The default provider for `javascript_runtime_test`.
+      #
+      # @see Resource
+      # @provides javascript_runtime_test
+      class Provider < Chef::Provider
+        include Poise
+        provides(:javascript_runtime_test)
+
+        # The `run` action for the `javascript_runtime_test` resource.
+        #
+        # @return [void]
+        def action_run
+          notifying_block do
+            # Top level directory for this test.
+            directory new_resource.path
+
+            # Install and log the version.
+            javascript_runtime new_resource.name do
+              provider new_resource.runtime_provider if new_resource.runtime_provider
+              version new_resource.version
+            end
+            test_version
+
+            # Create a package and test npm_install.
+            pkg_path = ::File.join(new_resource.path, 'pkg')
+            directory pkg_path
+            file ::File.join(pkg_path, 'package.json') do
+              content <<-EOH
+{
+  "name": "mypkg",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \\"Error: no test specified\\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "express": "4.13.3"
+  },
+  "devDependencies": {
+    "handlebars": "4.0.2"
+  }
+}
+EOH
+            end
+            npm_install pkg_path do
+              notifies :create, sentinel_file('npm_install_one'), :immediately
+            end
+            npm_install pkg_path+'2' do
+              path pkg_path
+              notifies :create, sentinel_file('npm_install_two'), :immediately
+            end
+            test_require('express', pkg_path)
+            test_require('handlebars', pkg_path)
+
+            # Test node_package.
+            test1_path = ::File.join(new_resource.path, 'test1')
+            directory test1_path
+            node_package 'express' do
+              path test1_path
+              notifies :create, sentinel_file('test1_express_one'), :immediately
+            end
+            node_package 'express two' do
+              package_name 'express'
+              path test1_path
+              notifies :create, sentinel_file('test1_express_two'), :immediately
+            end
+            node_package %w{gulp less} do
+              path test1_path
+              notifies :create, sentinel_file('test1_multi'), :immediately
+            end
+            node_package %w{express bower} do
+              path test1_path
+              notifies :create, sentinel_file('test1_multi_overlap'), :immediately
+            end
+            node_package 'bower' do
+              path test1_path
+              notifies :create, sentinel_file('test1_bower'), :immediately
+            end
+            node_package 'yo' do
+              path test1_path
+              version '1.4.5'
+            end if new_resource.test_yo
+            node_package 'forever' do
+              path test1_path
+              version '0.13.0'
+            end
+            test_require('express', test1_path, 'node_package_express')
+            test_require('gulp', test1_path)
+            test_require('less', test1_path)
+            test_require('bower', test1_path)
+            if new_resource.test_yo
+              test_require('yo', test1_path)
+            else
+              file ::File.join(new_resource.path, 'no_yo')
+            end
+            test_require('forever', test1_path)
+
+            # Check we don't get cross talk between paths.
+            test2_path = ::File.join(new_resource.path, 'test2')
+            directory test2_path
+            node_package 'express' do
+              path test2_path
+              notifies :create, sentinel_file('test2_express'), :immediately
+            end
+
+            # Test global installs.
+            node_package 'grunt-cli' do
+              notifies :create, sentinel_file('grunt_one'), :immediately
+            end
+            node_package 'grunt-cli two' do
+              package_name 'grunt-cli'
+              notifies :create, sentinel_file('grunt_two'), :immediately
+            end
+            test_require('grunt-cli', new_resource.path)
+            javascript_execute 'grunt-cli --version' do
+              command lazy {
+                # Check local/bin first and then just bin/.
+                grunt_path = ::File.expand_path('../../local/bin/grunt', javascript)
+                grunt_path = ::File.expand_path('../grunt', javascript) unless ::File.exist?(grunt_path)
+                "#{grunt_path} --version > #{::File.join(new_resource.path, 'grunt_version')}"
+              }
+            end
+
+          end
+        end
+
+        def sentinel_file(name)
+          file ::File.join(new_resource.path, "sentinel_#{name}") do
+            action :nothing
+          end
+        end
+
+        private
+
+        def test_version(javascript: new_resource.name)
+          # Only queue up this resource once, the ivar is just for tracking.
+          @javascript_version_test ||= file ::File.join(new_resource.path, 'javascript_version.js') do
+            user 'root'
+            group 'root'
+            mode '644'
+            content <<-EOH
+var fs = require('fs');
+fs.writeFileSync(process.argv[2], process.version);
+EOH
+          end
+
+          javascript_execute "#{@javascript_version_test.path} #{::File.join(new_resource.path, 'version')}" do
+            javascript javascript if javascript
+          end
+        end
+
+        def test_require(name, cwd, path=name, javascript: new_resource.name)
+          javascript_require_test = file ::File.join(cwd, 'javascript_require.js') do
+            user 'root'
+            group 'root'
+            mode '644'
+            content <<-EOH
+var fs = require('fs');
+try {
+  var version = require(process.argv[2] + '/package.json').version;
+  fs.writeFileSync(process.argv[3], version);
+} catch(e) {
+}
+EOH
+          end
+
+          javascript_execute "#{javascript_require_test.path} #{name} #{::File.join(new_resource.path, "require_#{path}")}" do
+            javascript javascript if javascript
+            cwd cwd
+          end
+        end
+
+      end
+    end
+  end
+end