metasploit-version 0.1.2-java → 0.1.3-java

data/features/metasploit-version/install/releasing/versioning.feature

@@ -0,0 +1,138 @@
+Feature: metasploit-version install should add RELEASING.md that handles pre-1.0.0 and post-1.0.0 versioning
+
+  `metasploit-version install` should have different directions for update the semantic version when it is < 1.0.0 and
+  >= 1.0.0.  These instructions should be based on the contents of CHANGELOG.md.
+
+  Background:
+    Given I successfully run `bundle gem released`
+    And I cd to "released"
+    And my git identity is configured
+    And I successfully run `git commit --message "bundle gem released"`
+    And I unset the environment variable "TRAVIS_BRANCH"
+    And I set the environment variables to:
+      | variable            | value |
+      | TRAVIS_PULL_REQUEST | false |
+
+  Scenario: < 1.0.0
+    When I successfully run `metasploit-version install --force --major 0 --minor 1 --patch 2 --no-bundle-install`
+    Then the file "RELEASING.md" should contain:
+      """
+      ### Compatible changes
+
+      If the [CHANGELOG.md](CHANGELOG.md) contains only Enhancements, Bug Fixes, and/or Deprecations for the Next Release then
+      increment [`PATCH`](lib/released/version.rb).
+
+      ### Incompatible changes
+
+      If the [CHANGELOG.md](CHANGELOG.md) contains any Incompatible Changes for the Next Release, then you can either (1)
+      decide to remain pre-1.0.0 or (2) advance to 1.0.0.
+
+      1. To remain pre-1..0.0, then increment [`MINOR`](lib/released/version.rb) and reset [`PATCH`](lib/released/version.rb) to `0`.
+      2. To advance to 1.0.0, increment [`MAJOR`](lib/released/version.rb) and reset [`MINOR`](lib/released/version.rb and [`PATCH`](lib/released/version.rb) to `0`.
+
+      """
+
+  Scenario: 1.0.0
+    When I successfully run `metasploit-version install --force --major 1 --minor 0 --patch 0 --no-bundle-install`
+    Then the file "RELEASING.md" should contain:
+      """
+      ### Bug fixes
+
+      If the [CHANGELOG.md](CHANGELOG.md) contains only Bug Fixes for the Next Release, then increment
+      [`PATCH`](lib/released/version.rb).
+
+      ### Compatible API changes
+
+      If the [CHANGELOG.md](CHANGELOG.md) contains any Enhancements or Deprecations, then increment
+      [`MINOR`](lib/released/version.rb) and reset [`PATCH`](lib/released/version.rb) to `0`.
+
+      ### Incompatible API changes
+
+      If the [CHANGELOG.md](CHANGELOG.md) contains any Incompatible Change, then increment [`MAJOR`](lib/released/version.rb) and
+      reset [`MINOR`](lib/released/version.rb and [`PATCH`](lib/released/version.rb) to `0`.
+
+      """
+
+  Scenario: Version indepedent
+    When I successfully run `metasploit-version install --force --major 0 --minor 1 --patch 2 --no-bundle-install`
+    Then the file "RELEASING.md" should contain:
+      """
+      # Releasing
+
+      These steps can be added to the Pull Request description's task list to remind the reviewer of how to release the
+      gem.
+
+      ```
+      # Release
+
+      Complete these steps on DESTINATION
+
+      ## [CHANGELOG.md](CHANGELOG.md)
+
+      ### Terminology
+
+      * "Enhancements" are widdening the API, such as by adding new classes or methods.
+      * "Bug Fixes" are fixes to the implementation that do not affect the public API.  If the public API is affected then
+        the change should be listed as both a "Bug Fix" and either an "Enhancement" or "Incompatible Change" depending on how
+        the bug was fixed.
+      * "Deprecations" are changes to the implementation that cause deprecation warnings to be issued for APIs which will be
+        removed in a future major release.  "Deprecations" are usually accompanied by an Enhancement that creates a new API
+        that is meant to be used in favor of the deprecated API.
+      * "Incompatbile Changes" are the removal of classes or methods or new required arguments or setup that shrink the API.
+        It is best practice to make a "Deprecation" for the API prior to its removal.
+
+      ### Task List
+
+      - [ ] Generate the list of changes since the last release: `git log v<LAST_MAJOR>.<LAST_MINOR>.<LAST_PATCH>..HEAD`
+      - [ ] For each commit in the release, find the corresponding PR by search for the commit on Github.
+      - [ ] For each PR, determine whether it is an Enhancement, Bug Fix, Deprecation, and/or Incompatible Change.  A PR can
+            be in more than one category, in which case it should be listed in each category it belongs, but with a category
+            specific description of the change.
+      - [ ] Add an item to each category's list in the following format: `[#<PR>](https://github.com/rapid7/released/pull/<PR>) <consumer summary> - [@<github_user>](https://github.com/<github_user>)`
+            `consumer_summary` should be a summary of the Enhancement, Bug Fix, Deprecation, or Incompatible Change from a
+            downstream consumer's of the library's perspective.  `github_user` should be Github handle of the author of the
+            PR.
+      - [ ] If you added any Deprecations or Incompatible Changes, then adding upgrading information to
+            [UPGRADING.md](UPGRADING.md)
+
+      ## `VERSION`
+
+      The entries in the [CHANGELOG.md](CHANGELOG.md) can be used to help determine how the `VERSION` should be bumped.
+
+      """
+    And the file "RELEASING.md" should contain:
+      """
+
+      ## Setup [CHANGELOG.md](CHANGELOG.md) for next release
+
+      - [ ] Change `Next Release` section name at the top of [CHANGELOG.md](CHANGELOG.md) to match the current `VERSION`.
+      - [ ] Add a new `Next Release` section above the `VERSION`'s section you just renamed:
+      <pre>
+      # Next Release
+
+      * Enhancements
+      * Bug Fixes
+      * Deprecations
+      * Incompatible Changes
+      </pre>
+
+      ## Release to rubygems.org
+
+      ## jruby
+      - [ ] `rvm use jruby@released`
+      - [ ] `rm Gemfile.lock`
+      - [ ] `bundle install`
+      - [ ] `rake release`
+
+      ## ruby-2.1
+      - [ ] `rvm use ruby-2.1@released`
+      - [ ] `rm Gemfile.lock`
+      - [ ] `bundle install`
+      - [ ] `rake release`
+      ```
+
+      ### Downstream dependencies
+
+      There are currently no known downstream dependenci
+      """
+

data/features/metasploit-version/install/steps/gemspec_steps.rb

@@ -0,0 +1,19 @@
+Then(/^metasploit\-version should be development dependency with semantic version restriction in "(.*?)"$/) do |gemspec_path|
+  version_requirement = if defined? Metasploit::Version::Version::PRERELEASE
+    # require exactly this pre-release in case there are multiple prereleases for the same
+    # version number due to parallel branches.
+    "= #{Metasploit::Version::GEM_VERSION}"
+  elsif Metasploit::Version::Version::MAJOR < 1
+    # can only allow the PATCH to wiggle pre-1.0.0
+    "~> #{Metasploit::Version::Version::MAJOR}.#{Metasploit::Version::Version::MINOR}.#{Metasploit::Version::Version::PATCH}"
+  else
+    # can allow the MINOR to wiggle 1.0.0+
+    "~> #{Metasploit::Version::Version::MAJOR}.#{Metasploit::Version::Version::MINOR}"
+  end
+
+  check_file_content(
+      gemspec_path,
+      %r{spec\.add_development_dependency\s*(?<quote>'|")metasploit-version\k<quote>,\s*\k<quote>#{version_requirement}\k<quote>},
+      true
+  )
+end

data/features/metasploit-version/install/upgrading.feature

@@ -0,0 +1,19 @@
+Feature: metasploit-version install should add UPGRADING.md
+
+  `metasploit-version install` should generate UPGRADING.md which includes any information needed by downstream
+  consumers of the gem when upgrading to handle Deprecations or Incompatible Changes.
+
+  Scenario:
+    Given I successfully run `bundle gem upgraded`
+    And I cd to "upgraded"
+    And my git identity is configured
+    And I successfully run `git commit --message "bundle gem upgraded"`
+    And I unset the environment variable "TRAVIS_BRANCH"
+    And I set the environment variables to:
+      | variable            | value |
+      | TRAVIS_PULL_REQUEST | false |
+    When I successfully run `metasploit-version install --force --no-bundle-install`
+    Then the file "UPGRADING.md" should contain:
+      """
+      No Deprecations or Incompatible Changes have been introduced at this time
+      """

data/features/metasploit-version/install/version.feature

@@ -0,0 +1,11 @@
+Feature: metasploit-version install adds 'version.rb' to replace default 'version.rb'
+
+  The version.rb file from metasploit-version will follow semver.org and define `MAJOR`, `MINOR`, and `PATCH`.  If on
+  a branch, the `PRERELEASE` will also be defined.  Default implementations for `Version.full` and `Version.gem` will
+  be provided and `VERSION` and `GEM_VERSION` will be set to the respective method.
+
+  Scenario: No gemspec
+    Given a file matching %r<.*\.gemspec> should not exist
+    When I run `metasploit-version install`
+    Then the output should contain "No gemspec found"
+    And the exit status should not be 0

data/features/metasploit-version/install/version/namespace.feature

@@ -0,0 +1,157 @@
+Feature: metasploit-version install's 'version.rb' generate proper namespace nesting
+
+  The version.rb file from metasploit-version will generate the appropriately indented nesting for single and multiple
+  namespaces with proper conversion of underscored and dashes in the gem name to camel case and separate modules,
+  respectively
+
+  Scenario Outline: Top-level namespace
+    Given I successfully run `bundle gem <gem_name>`
+    And I cd to "<gem_name>"
+    And my git identity is configured
+    And I successfully run `git commit --message "bundle gem <gem_name>"`
+    And I unset the environment variable "TRAVIS_BRANCH"
+    And I set the environment variables to:
+      | variable            | value |
+      | TRAVIS_PULL_REQUEST | false |
+    When I successfully run `metasploit-version install --force --no-bundle-install`
+    Then the file "<version_rb_path>" should contain exactly:
+      """
+      module <namespace_name>
+        # Holds components of {VERSION} as defined by {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0}.
+        module Version
+          #
+          # CONSTANTS
+          #
+
+          # The major version number.
+          MAJOR = 0
+          # The minor version number, scoped to the {MAJOR} version number.
+          MINOR = 0
+          # The patch version number, scoped to the {MAJOR} and {MINOR} version numbers.
+          PATCH = 1
+
+          #
+          # Module Methods
+          #
+
+          # The full version string, including the {<namespace_name>::Version::MAJOR},
+          # {<namespace_name>::Version::MINOR}, {<namespace_name>::Version::PATCH}, and optionally, the
+          # `<namespace_name>::Version::PRERELEASE` in the
+          # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
+          #
+          # @return [String] '{<namespace_name>::Version::MAJOR}.{<namespace_name>::Version::MINOR}.{<namespace_name>::Version::PATCH}' on master.
+          #   '{<namespace_name>::Version::MAJOR}.{<namespace_name>::Version::MINOR}.{<namespace_name>::Version::PATCH}-PRERELEASE'
+          #   on any branch other than master.
+          def self.full
+            version = "#{MAJOR}.#{MINOR}.#{PATCH}"
+
+            if defined? PRERELEASE
+              version = "#{version}-#{PRERELEASE}"
+            end
+
+            version
+          end
+
+          # The full gem version string, including the {<namespace_name>::Version::MAJOR},
+          # {<namespace_name>::Version::MINOR}, {<namespace_name>::Version::PATCH}, and optionally, the
+          # `<namespace_name>::Version::PRERELEASE` in the
+          # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
+          #
+          # @return [String] '{<namespace_name>::Version::MAJOR}.{<namespace_name>::Version::MINOR}.{<namespace_name>::Version::PATCH}'
+          #   on master.  '{<namespace_name>::Version::MAJOR}.{<namespace_name>::Version::MINOR}.{<namespace_name>::Version::PATCH}.PRERELEASE'
+          #   on any branch other than master.
+          def self.gem
+            full.gsub('-', '.pre.')
+          end
+        end
+
+        # (see Version.gem)
+        GEM_VERSION = Version.gem
+
+        # (see Version.full)
+        VERSION = Version.full
+      end
+
+      """
+
+    Examples:
+      | gem_name  | version_rb_path          | namespace_name |
+      | single    | lib/single/version.rb    | Single         |
+      | two_words | lib/two_words/version.rb | TwoWords       |
+
+  Scenario Outline: Two-level namespace
+    Given I successfully run `bundle gem <gem_name>`
+    And I cd to "<gem_name>"
+    And my git identity is configured
+    And I successfully run `git commit --message "bundle gem <gem_name>"`
+    And I unset the environment variable "TRAVIS_BRANCH"
+    And I set the environment variables to:
+      | variable            | value |
+      | TRAVIS_PULL_REQUEST | false |
+    When I successfully run `metasploit-version install --force --no-bundle-install`
+    Then the file "<version_rb_path>" should contain exactly:
+      """
+      module <parent_module_name>
+        module <child_module_name>
+          # Holds components of {VERSION} as defined by {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0}.
+          module Version
+            #
+            # CONSTANTS
+            #
+
+            # The major version number.
+            MAJOR = 0
+            # The minor version number, scoped to the {MAJOR} version number.
+            MINOR = 0
+            # The patch version number, scoped to the {MAJOR} and {MINOR} version numbers.
+            PATCH = 1
+
+            #
+            # Module Methods
+            #
+
+            # The full version string, including the {<parent_module_name>::<child_module_name>::Version::MAJOR},
+            # {<parent_module_name>::<child_module_name>::Version::MINOR}, {<parent_module_name>::<child_module_name>::Version::PATCH}, and optionally, the
+            # `<parent_module_name>::<child_module_name>::Version::PRERELEASE` in the
+            # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
+            #
+            # @return [String] '{<parent_module_name>::<child_module_name>::Version::MAJOR}.{<parent_module_name>::<child_module_name>::Version::MINOR}.{<parent_module_name>::<child_module_name>::Version::PATCH}' on master.
+            #   '{<parent_module_name>::<child_module_name>::Version::MAJOR}.{<parent_module_name>::<child_module_name>::Version::MINOR}.{<parent_module_name>::<child_module_name>::Version::PATCH}-PRERELEASE'
+            #   on any branch other than master.
+            def self.full
+              version = "#{MAJOR}.#{MINOR}.#{PATCH}"
+
+              if defined? PRERELEASE
+                version = "#{version}-#{PRERELEASE}"
+              end
+
+              version
+            end
+
+            # The full gem version string, including the {<parent_module_name>::<child_module_name>::Version::MAJOR},
+            # {<parent_module_name>::<child_module_name>::Version::MINOR}, {<parent_module_name>::<child_module_name>::Version::PATCH}, and optionally, the
+            # `<parent_module_name>::<child_module_name>::Version::PRERELEASE` in the
+            # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
+            #
+            # @return [String] '{<parent_module_name>::<child_module_name>::Version::MAJOR}.{<parent_module_name>::<child_module_name>::Version::MINOR}.{<parent_module_name>::<child_module_name>::Version::PATCH}'
+            #   on master.  '{<parent_module_name>::<child_module_name>::Version::MAJOR}.{<parent_module_name>::<child_module_name>::Version::MINOR}.{<parent_module_name>::<child_module_name>::Version::PATCH}.PRERELEASE'
+            #   on any branch other than master.
+            def self.gem
+              full.gsub('-', '.pre.')
+            end
+          end
+
+          # (see Version.gem)
+          GEM_VERSION = Version.gem
+
+          # (see Version.full)
+          VERSION = Version.full
+        end
+      end
+
+      """
+
+    Examples:
+      | gem_name         | version_rb_path                 | parent_module_name | child_module_name |
+      | parent-single    | lib/parent/single/version.rb    | Parent             | Single            |
+      | parent-two_words | lib/parent/two_words/version.rb | Parent             | TwoWords          |

data/features/metasploit-version/install/version/prerelease.feature

@@ -0,0 +1,154 @@
+Feature: metasploit-version install conditionally defines PRERELEASE in version.rb
+
+  The version.rb file will define PRERELEASE to the branch's prerelease name when `metasploit-version install` is run on
+  a branch, while it will not define PRERELEASE on master.
+
+  Scenario: No PRERELEASE on master
+    Given I successfully run `bundle gem master`
+    And I cd to "master"
+    And I unset the environment variable "TRAVIS_BRANCH"
+    And I set the environment variables to:
+      | variable            | value |
+      | TRAVIS_PULL_REQUEST | false |
+    And my git identity is configured
+    And I successfully run `git commit --message "bundle gem master"`
+    When I successfully run `metasploit-version install --force --no-bundle-install`
+    Then the file "lib/master/version.rb" should contain exactly:
+      """
+      module Master
+        # Holds components of {VERSION} as defined by {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0}.
+        module Version
+          #
+          # CONSTANTS
+          #
+
+          # The major version number.
+          MAJOR = 0
+          # The minor version number, scoped to the {MAJOR} version number.
+          MINOR = 0
+          # The patch version number, scoped to the {MAJOR} and {MINOR} version numbers.
+          PATCH = 1
+
+          #
+          # Module Methods
+          #
+
+          # The full version string, including the {Master::Version::MAJOR},
+          # {Master::Version::MINOR}, {Master::Version::PATCH}, and optionally, the
+          # `Master::Version::PRERELEASE` in the
+          # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
+          #
+          # @return [String] '{Master::Version::MAJOR}.{Master::Version::MINOR}.{Master::Version::PATCH}' on master.
+          #   '{Master::Version::MAJOR}.{Master::Version::MINOR}.{Master::Version::PATCH}-PRERELEASE'
+          #   on any branch other than master.
+          def self.full
+            version = "#{MAJOR}.#{MINOR}.#{PATCH}"
+
+            if defined? PRERELEASE
+              version = "#{version}-#{PRERELEASE}"
+            end
+
+            version
+          end
+
+          # The full gem version string, including the {Master::Version::MAJOR},
+          # {Master::Version::MINOR}, {Master::Version::PATCH}, and optionally, the
+          # `Master::Version::PRERELEASE` in the
+          # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
+          #
+          # @return [String] '{Master::Version::MAJOR}.{Master::Version::MINOR}.{Master::Version::PATCH}'
+          #   on master.  '{Master::Version::MAJOR}.{Master::Version::MINOR}.{Master::Version::PATCH}.PRERELEASE'
+          #   on any branch other than master.
+          def self.gem
+            full.gsub('-', '.pre.')
+          end
+        end
+
+        # (see Version.gem)
+        GEM_VERSION = Version.gem
+
+        # (see Version.full)
+        VERSION = Version.full
+      end
+
+      """
+
+  Scenario Outline: PRERELEASE on branch
+    Given I successfully run `bundle gem branch`
+    And I cd to "branch"
+    And I unset the environment variable "TRAVIS_BRANCH"
+    And I set the environment variables to:
+      | variable            | value |
+      | TRAVIS_PULL_REQUEST | false |
+    And my git identity is configured
+    And I successfully run `git commit --message "bundle gem branch"`
+    And I successfully run `git checkout -b <branch>`
+    When I successfully run `metasploit-version install --force --no-bundle-install`
+    Then the file "lib/branch/version.rb" should contain exactly:
+      """
+      module Branch
+        # Holds components of {VERSION} as defined by {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0}.
+        module Version
+          #
+          # CONSTANTS
+          #
+
+          # The major version number.
+          MAJOR = 0
+          # The minor version number, scoped to the {MAJOR} version number.
+          MINOR = 0
+          # The patch version number, scoped to the {MAJOR} and {MINOR} version numbers.
+          PATCH = 1
+          # The prerelease version, scoped to the {MAJOR}, {MINOR}, and {PATCH} version numbers.
+          PRERELEASE = '<prerelease>'
+
+          #
+          # Module Methods
+          #
+
+          # The full version string, including the {Branch::Version::MAJOR},
+          # {Branch::Version::MINOR}, {Branch::Version::PATCH}, and optionally, the
+          # `Branch::Version::PRERELEASE` in the
+          # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
+          #
+          # @return [String] '{Branch::Version::MAJOR}.{Branch::Version::MINOR}.{Branch::Version::PATCH}' on master.
+          #   '{Branch::Version::MAJOR}.{Branch::Version::MINOR}.{Branch::Version::PATCH}-PRERELEASE'
+          #   on any branch other than master.
+          def self.full
+            version = "#{MAJOR}.#{MINOR}.#{PATCH}"
+
+            if defined? PRERELEASE
+              version = "#{version}-#{PRERELEASE}"
+            end
+
+            version
+          end
+
+          # The full gem version string, including the {Branch::Version::MAJOR},
+          # {Branch::Version::MINOR}, {Branch::Version::PATCH}, and optionally, the
+          # `Branch::Version::PRERELEASE` in the
+          # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
+          #
+          # @return [String] '{Branch::Version::MAJOR}.{Branch::Version::MINOR}.{Branch::Version::PATCH}'
+          #   on master.  '{Branch::Version::MAJOR}.{Branch::Version::MINOR}.{Branch::Version::PATCH}.PRERELEASE'
+          #   on any branch other than master.
+          def self.gem
+            full.gsub('-', '.pre.')
+          end
+        end
+
+        # (see Version.gem)
+        GEM_VERSION = Version.gem
+
+        # (see Version.full)
+        VERSION = Version.full
+      end
+
+      """
+
+    Examples:
+      | branch                      | prerelease    |
+      | staging/flood-release       | flood-release |
+      | bug/MSP-666/nasty           | nasty         |
+      | chore/MSP-1234/recurring    | recurring     |
+      | feature/MSP-1337/super-cool | super-cool    |