aws_sam_yarn_builder 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84a6ff9a256e1732ea9e35fbe0797cb6acc7182513adf75398170d2ac35958b3
+  data.tar.gz: 5d60e78270fd623c4c5d7bff2d972a1e3a5457634e651c5a60cceb65c2ed8110
+SHA512:
+  metadata.gz: 04b422bbcc7c58b4020bb0a1d4698c7811c78ac1b71086702f874865e2e920ba3e496ee41b1a65f89b79865fecc128c55521069cd02f54daf1780242e0f905c5
+  data.tar.gz: e5f56b438c8a09b61330368a87c43a8d5604adf9c3cdbb3da67bcc0f4a8b1c704afccf0804f9656bae6460405807b3d1ccb067e166f9563dd17ffe8b7293d6c9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.aws-sam

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at eallam@icloud.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem 'pry'
+
+# Specify your gem's dependencies in aws-sam-yarn-builder.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    aws_sam_yarn_builder (0.1.1)
+      activesupport (~> 5.2.2)
+      slop (~> 4.6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.4)
+    i18n (1.4.0)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    slop (4.6.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aws_sam_yarn_builder!
+  bundler (~> 1.16)
+  pry
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,81 @@
+# sam-build-yarn
+
+Command to build AWS SAM apps that use nodejs with `yarn`.
+
+Supports local file dependencies, and matches the `sam build` command output so you can use the `sam-build-yarn` command as a replacement for `sam build`.
+
+**NOTE:** Currently _does not_ support building using a container e.g. `sam build --container`
+
+## New Features:
+
+- Specify commands to run before building in a function by including a `sam:prebuild` script in the `package.json`.
+
+## Installation
+
+AWS SAM Yarn Builder is a ruby gem, so you can install it using this command:
+
+    $ gem install aws-sam-yarn-builder
+
+## Usage
+
+Execute:
+
+    $ sam-build-yarn
+
+Assumes the template is located at the root of the project and named `template.yml`. You can specify a different template file like so:
+
+    $ sam-build-yarn --template-file ./samapp.yaml
+
+### Example App
+
+For an example of how this builder can work, here is the layout of an example SAM app with a single function (under `src`) with a local nodejs dependency (under `lib`):
+
+```
+sam-app/
+├── lib/
+│   └── local-dependency/
+│       ├── index.js
+│       └── package.json
+└── src/
+    └── hello-world/
+        ├── app.js
+        └── package.json
+```
+
+The `hello-world/package.json` contents look like this:
+
+```json
+{
+  "name": "hello_world",
+  "version": "1.0.0",
+  "dependencies": {
+    "local-file-dependency": "file:../../lib/local-file-dependency"
+  }
+}
+```
+
+With this layout and setup, you would not be able to build with `sam build` because it doesn't support dependencies that point to a file on the local filesystem.
+
+`sam-build-yarn` will inspect all function package.json files for local file dependencies and "stage" them into the build before building each function, overriding the dependencies path in the package.json to point to the staged one.
+
+The result of the build after running `sam-build-yarn` matches that of `sam build`:
+
+```
+sam-app/
+├── .aws-sam/
+│   └── build/
+│       ├── HelloWorldFunction/
+│       │   ├── node_modules/
+│       │   ├── app.js
+│       │   ├── package.json
+│       │   └── yarn.lock
+│       └── template.yaml
+├── lib/
+│   └── local-dependency/
+│       ├── index.js
+│       └── package.json
+└── src/
+    └── hello-world/
+        ├── app.js
+        └── package.json
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require "rake/testtask"
+
+task default: :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.warning = true
+  t.verbose = true
+end
+
+require "bundler/gem_tasks"

data/aws_sam_yarn_builder.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "aws_sam_yarn_builder/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "aws_sam_yarn_builder"
+  spec.version = AwsSamYarnBuilder::VERSION
+  spec.authors = ["Eric Allam"]
+  spec.email = ["eallam@icloud.com"]
+
+  spec.summary = %q{A command line program to produce builds for aws-sam-cli for nodejs/yarn projects}
+  spec.description = %q{A command line program to produce builds for aws-sam-cli for nodejs/yarn projects}
+  spec.homepage = "https://github.com/ericallam/aws-sam-yarn-builder"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+
+  spec.add_dependency "slop", "~> 4.6.0"
+  spec.add_dependency "activesupport", "~> 5.2.2"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/sam-build-yarn

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "aws_sam_yarn_builder"
+
+opts = AwsSamYarnBuilder::OptionParser.parse!
+
+builder = AwsSamYarnBuilder::Build.new opts
+builder.build!

data/lib/aws_sam_yarn_builder.rb

@@ -0,0 +1,14 @@
+
+require "active_support/dependencies/autoload"
+require "active_support/core_ext/hash"
+require "fileutils"
+require "json"
+
+module AwsSamYarnBuilder
+  extend ActiveSupport::Autoload
+
+  autoload :Package
+  autoload :Build
+  autoload :Template
+  autoload :OptionParser
+end

data/lib/aws_sam_yarn_builder/build.rb

@@ -0,0 +1,71 @@
+module AwsSamYarnBuilder
+  class Build
+    def initialize(options = {})
+      self.options = options
+    end
+
+    def build!
+      reset_build_dir!
+      reset_staging_dir!
+
+      local_dependencies = template.function_resources.map do |function|
+        get_local_file_dependencies(function)
+      end.flatten.uniq.compact
+
+      local_dependencies.each do |d|
+        d.pack destination_staging_dir
+      end
+
+      template.function_resources.each do |function|
+        package = package_from_function(function)
+
+        package.pack destination_staging_dir
+        package.build function.name, destination_dir, destination_staging_dir
+      end
+
+      template.write_to_output(destination_dir)
+
+      FileUtils.rm_rf(destination_staging_dir)
+    end
+
+    protected
+
+    attr_accessor :options
+
+    def get_local_file_dependencies(function)
+      package = package_from_function(function)
+
+      package.dependencies.select(&:local?)
+    end
+
+    def package_from_function(function)
+      Package.extract_from_file! File.join(File.expand_path(File.join(template_base_dir, function.path)), "package.json")
+    end
+
+    def reset_staging_dir!
+      FileUtils.rm_rf(destination_staging_dir)
+      FileUtils.mkdir_p(destination_staging_dir)
+    end
+
+    def reset_build_dir!
+      FileUtils.rm_rf(destination_dir)
+      FileUtils.mkdir_p(destination_dir)
+    end
+
+    def destination_dir
+      @destination_dir ||= File.join(File.expand_path(options[:destination]), "build")
+    end
+
+    def destination_staging_dir
+      @destination_staging_dir ||= File.join(File.expand_path(options[:destination]), "tmp")
+    end
+
+    def template
+      @template ||= Template.extract_from_file!(File.expand_path(options[:template_file]))
+    end
+
+    def template_base_dir
+      File.dirname(File.expand_path(options[:template_file]))
+    end
+  end
+end

data/lib/aws_sam_yarn_builder/option_parser.rb

@@ -0,0 +1,17 @@
+require "slop"
+
+module AwsSamYarnBuilder
+  module OptionParser
+    def self.parse!
+      Slop.parse do |o|
+        o.string "-d", "--destination", "path to use for the output of the build process", default: "./.aws-sam"
+        o.string "-t", "--template-file", "path to the SAM template file", default: "./template.yml"
+
+        o.on "--help" do
+          puts o
+          exit
+        end
+      end
+    end
+  end
+end

data/lib/aws_sam_yarn_builder/package.rb

@@ -0,0 +1,179 @@
+module AwsSamYarnBuilder
+  class Package
+    class Dependency
+      def initialize(parent, name, version)
+        self.parent = parent
+        self.name = name
+        self.version = version
+      end
+
+      def local?
+        version.start_with? "file:"
+      end
+
+      def pack(output)
+        Package.extract_from_file!(File.join(local_path, "package.json")).pack(output)
+      end
+
+      def ==(o)
+        o.class == self.class && o.name == name
+      end
+
+      def hash
+        name.hash
+      end
+
+      alias_method :eql?, :==
+
+      attr_reader :name, :version
+
+      protected
+
+      attr_writer :version, :name
+      attr_accessor :parent
+
+      def local_path
+        File.expand_path(File.join(File.dirname(parent.path), version.gsub(/^file:/, "")))
+      end
+    end
+
+    def self.extract_from_file!(file_path)
+      new file_path, JSON.parse(File.read(file_path))
+    end
+
+    def initialize(path, contents)
+      self.path = path
+      self.contents = contents.with_indifferent_access
+    end
+
+    def name
+      contents[:name]
+    end
+
+    def version
+      contents[:version]
+    end
+
+    def dependencies
+      @dependencies ||= contents[:dependencies].map { |name, version| Dependency.new(self, name, version) }
+    end
+
+    def dev_dependencies
+      @dev_dependencies ||= contents[:devDependencies].map { |name, version| Dependency.new(self, name, version) }
+    end
+
+    def has_sam_prebuild_script?
+      contents[:scripts].present? && contents[:scripts]["sam:prebuild"].present?
+    end
+
+    def pack(output)
+      change_to_directory do
+        execute_command("yarn run sam:prebuild") if has_sam_prebuild_script?
+        execute_command("yarn pack")
+      end
+
+      FileUtils.mv packaged_tarball_path, output
+
+      Dir.chdir output do
+        execute_command("tar zxvf #{packed_tarball_name}")
+
+        FileUtils.mkdir_p name
+        File.rename "package", name
+
+        FileUtils.rm packed_tarball_name
+      end
+
+      package_json_path = File.join(output, name, "package.json")
+
+      File.open(package_json_path, "w+") do |file|
+        file << JSON.pretty_generate(overrite_local_dependencies)
+      end
+    end
+
+    def build(output_name, output, tmp_directory)
+      tmp_package_path = File.join(tmp_directory, name)
+
+      yarn_lock_path = File.join(base_path, "yarn.lock")
+
+      FileUtils.cp yarn_lock_path, tmp_package_path
+
+      Dir.chdir tmp_package_path do
+        puts "Yarn Installing for #{name}"
+
+        execute_command("yarn install --ignore-scripts --production --pure-lockfile")
+      end
+
+      deploy_package_path = File.join(output, output_name)
+
+      FileUtils.rm_rf deploy_package_path
+      FileUtils.mv tmp_package_path, deploy_package_path
+
+      package_json_path = File.join(deploy_package_path, "package.json")
+
+      File.open(package_json_path, "w+") do |file|
+        file << JSON.pretty_generate(contents)
+      end
+    end
+
+    attr_reader :path
+
+    protected
+
+    attr_accessor :contents
+    attr_writer :path
+
+    def overrite_local_dependencies
+      result = Marshal.load(Marshal.dump(contents))
+
+      result[:dependencies] = contents[:dependencies].inject({}) do |deps, (name, version)|
+        if version.start_with?("file:")
+          deps[name] = "file:../#{name}"
+        else
+          deps[name] = version
+        end
+
+        deps
+      end
+
+      result[:devDependencies] = contents[:devDependencies].inject({}) do |deps, (name, version)|
+        if version.start_with?("file:")
+          deps[name] = "file:../#{name}"
+        else
+          deps[name] = version
+        end
+
+        deps
+      end
+
+      result
+    end
+
+    def change_to_directory(&block)
+      Dir.chdir base_path, &block
+    end
+
+    def base_path
+      File.dirname(path)
+    end
+
+    def packaged_tarball_path
+      File.join(base_path, packed_tarball_name)
+    end
+
+    def packed_tarball_name
+      packed_name + ".tgz"
+    end
+
+    def packed_name
+      [name.gsub(/\//, "-").gsub(/@/, ""), "v#{version}"].join("-")
+    end
+
+    def execute_command(command)
+      if !command
+        return
+      end
+
+      system command
+    end
+  end
+end

data/lib/aws_sam_yarn_builder/template.rb

@@ -0,0 +1,72 @@
+require "yaml"
+
+module AwsSamYarnBuilder
+  class Template
+    class FunctionResource
+      def initialize(name, properties = {})
+        self.name = name
+        self.properties = properties
+      end
+
+      def path
+        properties["CodeUri"]
+      end
+
+      attr_reader :name
+
+      protected
+
+      attr_accessor :properties
+      attr_writer :name
+    end
+
+    def self.extract_from_file!(file_path)
+      new file_path, File.read(file_path)
+    end
+
+    def initialize(path, contents)
+      self.path = path
+      self.contents = contents
+    end
+
+    def write_to_output(output)
+      File.open(File.join(output, "template.yaml"), "w+") do |file|
+        file << YAML.dump(document_with_transformed_function_paths)
+      end
+    end
+
+    def transform
+      document["Transform"]
+    end
+
+    def function_resources
+      @function_resources ||= raw_function_resources.map { |name, options| FunctionResource.new(name, options["Properties"]) }
+    end
+
+    protected
+
+    attr_accessor :contents, :path
+
+    def document
+      @document ||= YAML.load(contents)
+    end
+
+    def document_with_transformed_function_paths
+      transformed_document = Marshal.load(Marshal.dump(document))
+
+      raw_function_resources.each do |name, resource|
+        transformed_document["Resources"][name]["Properties"]["CodeUri"] = "./#{name}"
+      end
+
+      transformed_document
+    end
+
+    def raw_resources
+      document["Resources"]
+    end
+
+    def raw_function_resources
+      raw_resources.select { |name, options| options["Type"] == "AWS::Serverless::Function" }
+    end
+  end
+end

data/lib/aws_sam_yarn_builder/version.rb

@@ -0,0 +1,3 @@
+module AwsSamYarnBuilder
+  VERSION = "0.1.2"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: aws_sam_yarn_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Eric Allam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A command line program to produce builds for aws-sam-cli for nodejs/yarn
+  projects
+email:
+- eallam@icloud.com
+executables:
+- sam-build-yarn
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- aws_sam_yarn_builder.gemspec
+- bin/sam-build-yarn
+- lib/aws_sam_yarn_builder.rb
+- lib/aws_sam_yarn_builder/build.rb
+- lib/aws_sam_yarn_builder/option_parser.rb
+- lib/aws_sam_yarn_builder/package.rb
+- lib/aws_sam_yarn_builder/template.rb
+- lib/aws_sam_yarn_builder/version.rb
+homepage: https://github.com/ericallam/aws-sam-yarn-builder
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A command line program to produce builds for aws-sam-cli for nodejs/yarn
+  projects
+test_files: []