danger-migrations 0.15.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2bbab97b583c8624b1bd9888ffc87b4b3b7795ead6e3ff0a6d240bc92f4072e
+  data.tar.gz: 54a4301bed56abcbfe9b0ddb33a9b6bc39b52ba72191a8981e5b7be93dc6e243
+SHA512:
+  metadata.gz: 89b8cbaf9fd9519365cab32c3509bd964dbfae868aec2f6e01fff09dd478b741c39a86e9fb97f59e83741ee871f093f3c6388647b3d2b69dec9e05db641df05e
+  data.tar.gz: 061a43cbee49cf2dc6130e2fc2e4cbe630a4d88f817b27cc905e539e80ec3d222c56fefe153c0c6899ca6e7e7500e20d5e12a03b1ab49e942557312a90a699d4

data/README.md

@@ -0,0 +1,162 @@
+# danger-packwerk
+
+`danger-packwerk` integrates [`packwerk`](https://github.com/Shopify/packwerk) with [`danger`](https://github.com/danger/danger) to provide inline comments in PRs related to boundaries in a Rails application.
+
+## Installation and Basic Usage
+Step 1: Add this line to your `Gemfile` (to whatever group your CI uses, as it is not needed in production) and `bundle install`:
+
+```ruby
+gem 'danger-packwerk', group: :test
+```
+
+Step 2: Add these to your `Dangerfile`:
+
+```ruby
+packwerk.check
+package_todo_yml_changes.check
+```
+
+That's it for basic usage!
+
+## Advanced Usage
+
+There are currently two danger checks that ship with `danger-packwerk`:
+1) One that runs `bin/packwerk check` and leaves inline comments in source code on new violations
+2) One that looks at changes to `package_todo.yml` files and leaves inline comments on added violations.
+
+In upcoming iterations, we will include other danger checks, including:
+1) A danger check that detects changes to `package.yml` files and posts user-configurable messages on the `package.yml` files that are modified.
+2) A danger check that detects changes to `packwerk.yml` files and allows you to specify the action taken when that happens.
+
+## packwerk.check
+![This is an image displaying a comment from the Danger github bot after running bin/packwerk check.](docs/check_1.png)
+![This is an image displaying a comment from the Danger github bot after running bin/packwerk check with the "quick suggestions" accordian open](docs/check_2.png)
+
+Without any configuration, `packwerk.check` should just work. By default, it will post a maximum of 15 messages in a PR and it will not fail the build.
+
+`packwerk.check` can be configured to in the following ways:
+
+### Change the message that displays in the markdown
+To customize the message in the GitHub comment, pass in `offenses_formatter` to `packwerk.check` in your `Dangerfile`. Here's a simple example:
+```ruby
+class MyFormatter
+  extend T::Sig
+  include DangerPackwerk::Check::OffensesFormatter
+  # Packwerk::ReferenceOffense: https://github.com/Shopify/packwerk/blob/main/lib/packwerk/reference_offense.rb
+  sig do
+    override.params(
+      offenses: T::Array[Packwerk::ReferenceOffense],
+      repo_link: String,
+      org_name: String
+      repo_url_builder: T.nilable(T.proc.params(constant_path: String).returns(String))
+    ).returns(String)
+  end
+  def format_offenses(offenses, repo_link, org_name, repo_builder_url: nil)
+    # your logic here
+  end
+end
+
+packwerk.check(offenses_formatter: MyFormatter.new)
+```
+
+If you'd like to keep the default messaging but add some context customized to your organization, you can pass that in as follows:
+```ruby
+custom_help_message = "Need help? Check out our internal docs [here](www.example.com)"
+packwerk.check(offenses_formatter: DangerPackwerk::Check::DefaultFormatter.new(custom_help_message: custom_help_message))
+```
+
+### Fail the build on new violations
+Simply pass in `fail_build: true` into `check`, as such:
+```ruby
+packwerk.check(fail_build: true)
+```
+
+If you want to change the default error message, which is `Packwerk violations were detected! Please resolve them to unblock the build.`, then you can also pass in `failure_message`.
+
+### Change the max number of comments that will display
+If you do not change this, the default max is 15. More information about why we chose this number in the source code.
+```ruby
+packwerk.check(max_comments: 3)
+```
+
+### Do something extra when there are packwerk failures
+Maybe you want to notify slack or do something else when there are packwerk failures.
+
+```ruby
+packwerk.check(
+  # Offenses are a T::Array[Packwerk::ReferenceOffense] => https://github.com/Shopify/packwerk/blob/main/lib/packwerk/reference_offense.rb
+  on_failure: -> (offenses) do
+    # Notify slack or otherwise do something extra!
+  end
+)
+```
+
+### Supporting new violation types
+By default, only `dependency` and `privacy` violation types are supported. If you wish to use other violation types you'll need to provide them when calling `check`:
+```ruby
+packwerk.check(
+  violation_types: %w[dependency privacy layer]
+)
+```
+
+Any violations not included in this list will be ignored.
+
+You will also most likely want to customize the offenses formatter and provide specific feedback for the new violation types.
+
+## package_todo_yml_changes.check
+![This is an image displaying an inline comment from the Danger github bot.](docs/update.png)
+
+Without any configuration, `package_todo_yml_changes.check` should just work. By default, it will post a maximum of 15 messages in a PR, using default messaging defined within this gem.
+
+`package_todo_yml_changes.check` can be configured to in the following ways:
+
+### Change the message that displays in the markdown
+To customize the message in the GitHub comment, pass in `offenses_formatter` to `package_todo_yml_changes.check` in your `Dangerfile`. Here's a simple example:
+```ruby
+class MyFormatter
+  extend T::Sig
+  include DangerPackwerk::Update::OffensesFormatter
+  # DangerPackwerk::BasicReferenceOffense
+  sig do
+    override.params(
+      offenses: T::Array[Packwerk::ReferenceOffense],
+      repo_link: String,
+      org_name: String
+      repo_url_builder: T.nilable(T.proc.params(constant_path: String).returns(String))
+    ).returns(String)
+  end
+  def format_offenses(offenses, repo_link, org_name, repo_builder_url: nil)
+    # your logic here
+  end
+end
+
+package_todo_yml_changes.check(offenses_formatter: MyFormatter.new)
+```
+
+If you'd like to keep the default messaging but add some context customized to your organization, you can pass that in as follows:
+```ruby
+custom_help_message = "Need help? Check out our internal docs [here](www.example.com)"
+package_todo_yml_changes.check(offenses_formatter: DangerPackwerk::Update::DefaultFormatter.new(custom_help_message: custom_help_message))
+```
+
+### Change the max number of comments that will display
+If you do not change this, the default max is 15. More information about why we chose this number in the source code.
+```ruby
+package_todo_yml_changes.check(max_comments: 3)
+```
+
+### Do something extra before we leave comments
+Maybe you want to notify slack or do something else before we leave comments.
+
+```ruby
+package_todo_yml_changes.check(
+  # violation_diff is a DangerPackwerk::ViolationDiff and changed_package_todo_ymls is a T::Array[String]
+  before_comment: -> (violation_diff, changed_package_todo_ymls) do
+    # Notify slack or otherwise do something extra!
+  end
+)
+```
+
+## Development
+
+We welcome your contributions! Please create an issue or pull request and we'd be happy to take a look.

data/lib/danger-migrations/migrations_alone.rb

@@ -0,0 +1,99 @@
+# @team Developer Productivity Rails
+# typed: strict
+# frozen_string_literal: true
+
+require 'danger'
+
+module Danger
+  class MigrationsAlone < Plugin
+    extend T::Sig
+
+    MIGRATION_DEPENDENT_PATTERNS = T.let([%r(ar_doc/), %r(db/), %r(\Agems/.*/spec/dummy/db/)].freeze, T::Array[Regexp])
+    ALLOWED_FOLDERS = T.let([%r(\Aspec/), %r(\Apacks/.*/spec/), %r(\Agems/.*/spec/), %r(\Asorbet/rails-rbi/), %r(\Asorbet/rbi/dsl/)].freeze, T::Array[Regexp])
+
+    sig { void }
+    def check
+      return if new_migrations.empty?
+
+      disallowed_changed_files = find_disallowed_changed_files
+      if disallowed_changed_files.any?
+        file_list = (files - disallowed_changed_files).map { |path| "<li>#{path}</li>" }.join("\n")
+        disallowed_files = disallowed_changed_files.map { |path| "<li>#{path}</li>" }.join("\n")
+
+        message = <<~MESSAGE
+          <b>Migrations must be checked in alone.</b>
+          To ensure application code is not dependent on database migrations taking place
+          during the deploys, <i>please separate the schema change along with migration files into a dedicated PR:</i>
+          <ul>
+            #{file_list}
+          </ul>
+
+          <b>List of disallowed files</b>
+          <ul>
+            #{disallowed_files}
+          </ul>
+          <a href='https://confluence.gustocorp.com/display/BE/Database+Schema+Migrations+in+Hawaiian+Ice'>More information</a>
+        MESSAGE
+
+        fail message
+      end
+    end
+
+    private
+
+    sig { returns(T::Array[String]) }
+    def find_disallowed_changed_files
+      files.reject do |file_path|
+        next true if migration?(file_path)
+
+        next true if %r(\Adb/.*structure.sql).match?(file_path)
+
+        next true if %r(\Adb/.*seeds.rb).match?(file_path)
+
+        next true if allow_listed_file?(file_path, MIGRATION_DEPENDENT_PATTERNS)
+
+        next true if allow_listed_file?(file_path, ALLOWED_FOLDERS)
+
+        next true if comment_and_whitespace_changes_only?(file_path)
+      end
+    end
+
+    sig { returns(T::Array[String]) }
+    def new_migrations
+      git.added_files.select { |file_path| migration?(file_path) }
+    end
+
+    sig { params(file_path: String).returns(T::Boolean) }
+    def migration?(file_path)
+      %r(db/migrate/[^/]+\z).match?(file_path)
+    end
+
+    sig { params(file_path: String, patterns: T::Array[Regexp]).returns(T::Boolean) }
+    def allow_listed_file?(file_path, patterns)
+      patterns.any? { |pattern| pattern =~ file_path }
+    end
+
+    sig { params(file: String).returns(T::Boolean) }
+    def comment_and_whitespace_changes_only?(file)
+      return false unless git.modified_files.include?(file)
+
+      cleaned_diff(file).all? do |line|
+        # comment added || comment removed || whitespace added || whitespace removed
+        line.start_with?('+#', '-#') || line =~ /\A\+\s*\z/ || line =~ /\A-\s*\z/
+      end
+    end
+
+    sig { params(file_path: String).returns(T::Array[String]) }
+    def cleaned_diff(file_path)
+      diff = git.diff_for_file(file_path)
+      diff.patch.lines.select do |line|
+        line.start_with?('-', '+') && !line.include?(diff.path)
+      end
+    end
+
+    sig { returns(T::Array[String]) }
+    def files
+      git.added_files + git.modified_files + git.deleted_files
+    end
+  end
+end

data/lib/danger-migrations/private/git.rb

@@ -0,0 +1,66 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'code_ownership'
+require 'packs'
+
+# In order to support running danger-migrations from a non-root filepath, we need
+# to wrap some git functions in filesystem wrappers: packwerk runs relative to
+# the rails app root, whereas git returns paths on the actual filesystem.
+module DangerMigrations
+  module Private
+    class GitFilesystem < T::Struct
+      extend T::Sig
+
+      const :git, Danger::DangerfileGitPlugin
+      const :root, String
+
+      sig { returns(T::Array[{ after: String, before: String }]) }
+      def renamed_files
+        @git.renamed_files.map do |f|
+          {
+            after: convert_file_from_filesystem(f[:after]),
+            before: convert_file_from_filesystem(f[:before]),
+          }
+        end
+      end
+
+      sig { returns(T::Array[String]) }
+      def modified_files
+        convert_from_filesystem(@git.modified_files.to_a)
+      end
+
+      sig { returns(T::Array[String]) }
+      def deleted_files
+        convert_from_filesystem(@git.deleted_files.to_a)
+      end
+
+      sig { returns(T::Array[String]) }
+      def added_files
+        convert_from_filesystem(@git.added_files.to_a)
+      end
+
+      sig { params(filename_on_disk: String).returns(::Git::Diff::DiffFile) }
+      def diff(filename_on_disk)
+        @git.diff[filename_on_disk]
+      end
+
+      sig { params(path: String).returns(String) }
+      def convert_to_filesystem(path)
+        Pathname(@root).join(path).to_s
+      end
+
+      private
+
+      sig { params(files: T::Array[String]).returns(T::Array[String]) }
+      def convert_from_filesystem(files)
+        files.map { |f| convert_file_from_filesystem(f) }
+      end
+
+      sig { params(file: String).returns(String) }
+      def convert_file_from_filesystem(file)
+        Pathname(file).relative_path_from(@root).to_s
+      end
+    end
+  end
+end

data/lib/danger-migrations/version.rb

@@ -0,0 +1,6 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DangerMigrations
+  VERSION = '0.15.0'
+end

data/lib/danger-migrations.rb

@@ -0,0 +1,6 @@
+# typed: strict
+# frozen_string_literal: true
+
+# This file exists so clients can call `require 'danger-migrations'`
+require 'sorbet-runtime'
+require 'danger-migrations/migrations_alone'

data/lib/danger_plugin.rb

@@ -0,0 +1,4 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative 'danger/migrations'

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: danger-migrations
+version: !ruby/object:Gem::Version
+  version: 0.15.0
+platform: ruby
+authors:
+- Gusto Engineers
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Danger plugin for migrations.
+email:
+- dev@gusto.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/danger-migrations.rb
+- lib/danger-migrations/migrations_alone.rb
+- lib/danger-migrations/private/git.rb
+- lib/danger-migrations/version.rb
+- lib/danger_plugin.rb
+homepage: https://github.com/rubyatscale/danger-migrations
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rubyatscale/danger-migrations
+  source_code_uri: https://github.com/rubyatscale/danger-migrations
+  changelog_uri: https://github.com/rubyatscale/danger-migrations/releases
+  allowed_push_host: https://rubygems.org
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Danger plugin for migrations.
+test_files: []