metasploit-version 0.1.2-java

data/features/shared/examples/metasploit/version/version_module/prerelease/travis_ci/branch.feature

@@ -0,0 +1,173 @@
+Feature: 'Metasploit::Version Version Module' shared example in branch build on Travis-CI
+
+  The 'Metasploit::Version Version Module' shared example will check that the described_class for an RSpec *_spec.rb
+  file defines PRERELEASE to match the relative name of branch.
+
+  Background:
+    Given I set the environment variables to:
+      | variable            | value |
+      | TRAVIS_PULL_REQUEST | false |
+    Given a file named "lib/my_namespace/my_gem.rb" with:
+      """ruby
+      require 'my_namespace/my_gem/version'
+
+      module MyNamespace
+        module MyGem
+        end
+      end
+      """
+    Given a file named "spec/spec_helper.rb" with:
+      """ruby
+      require 'metasploit/version'
+      require 'my_namespace/my_gem'
+
+      # Use find_all_by_name instead of find_by_name as find_all_by_name will return pre-release versions
+      gem_specification = Gem::Specification.find_all_by_name('metasploit-version').first
+
+      Dir[File.join(gem_specification.gem_dir, 'spec', 'support', '**', '*.rb')].each do |f|
+        require f
+      end
+      """
+    Given a file named "spec/lib/my_namespace/my_gem/version_spec.rb" with:
+      """ruby
+      require 'spec_helper'
+
+      RSpec.describe MyNamespace::MyGem::Version do
+        it_should_behave_like 'Metasploit::Version Version Module'
+      end
+      """
+
+  Scenario Outline: PRERELEASE defined as branch relative name
+    Given a file named "lib/my_namespace/my_gem/version.rb" with:
+      """ruby
+      module MyNamespace
+        module MyGem
+          module Version
+            #
+            # CONSTANTS
+            #
+
+            # The major version number
+            MAJOR = 1
+
+            # The minor version number, scoped to the {MAJOR} version number.
+            MINOR = 2
+
+            # The patch number, scoped to the {MINOR} version number
+            PATCH = 3
+
+            # The prerelease name of the given {MAJOR}.{MINOR}.{PATCH} version number.  Will not be defined on master.
+            PRERELEASE = '<prerelease>'
+
+            # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+            # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
+            #
+            # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{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 {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+            # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
+            #
+            # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}.{PRERELEASE}' on any branch
+            #   other than master.
+            def self.gem
+              full.gsub('-', '.pre.')
+            end
+          end
+        end
+      end
+      """
+    Given I set the environment variables to:
+      | variable      | value     |
+      | TRAVIS_BRANCH | <branch>  |
+    When I run `rspec spec/lib/my_namespace/my_gem/version_spec.rb --format documentation`
+    Then the output should contain:
+      """
+            PRERELEASE
+              matches the <type> branch's name
+      """
+
+    Examples:
+      | type    | prerelease   | branch                      |
+      | bug     | nasty        | bug/MSP-1234/nasty          |
+      | feature | super-cool   | feature/MSP-1234/super-cool |
+      | staging | rocket-motor | staging/rocket-motor        |
+
+  Scenario Outline: PRERELEASE not defined
+    Given a file named "lib/my_namespace/my_gem/version.rb" with:
+      """ruby
+      module MyNamespace
+        module MyGem
+          module Version
+            #
+            # CONSTANTS
+            #
+
+            # The major version number
+            MAJOR = 1
+
+            # The minor version number, scoped to the {MAJOR} version number.
+            MINOR = 2
+
+            # The patch number, scoped to the {MINOR} version number
+            PATCH = 3
+
+            # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+            # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
+            #
+            # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{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 {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+            # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
+            #
+            # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}.{PRERELEASE}' on any branch
+            #   other than master.
+            def self.gem
+              full.gsub('-', '.pre.')
+            end
+          end
+        end
+      end
+      """
+    Given I set the environment variables to:
+      | variable      | value     |
+      | TRAVIS_BRANCH | <branch>  |
+    When I run `rspec spec/lib/my_namespace/my_gem/version_spec.rb --format documentation`
+    Then the output should contain "MyNamespace::MyGem::Version it should behave like Metasploit::Version Version Module CONSTANTS PRERELEASE matches the <type> branch's name"
+    And the output should contain:
+      """
+             expected MyNamespace::MyGem::Version::PRERELEASE to be defined.
+             Add the following to MyNamespace::MyGem::Version:
+      """
+    # Can't do a continuous multiline string because editors will truncate whitespace in blank line and it won't match
+    # whitespace in rspec output.
+    And the output should contain:
+      """
+                 # The prerelease version, scoped to the {PATCH} version number.
+                 PRERELEASE = <prerelease>
+      """
+
+    Examples:
+      | type    | prerelease   | branch                      |
+      | bug     | nasty        | bug/MSP-1234/nasty          |
+      | feature | super-cool   | feature/MSP-1234/super-cool |
+      | staging | rocket-motor | staging/rocket-motor        |

data/features/shared/examples/metasploit/version/version_module/prerelease/travis_ci/master.feature

@@ -0,0 +1,90 @@
+Feature: 'Metasploit::Version Version Module' shared example in master build on Travis-CI
+
+  The 'Metasploit::Version Version Module' shared example will check that the described_class for an RSpec *_spec.rb
+  file does not define PRERELEASE.
+
+  Background:
+    Given a file named "lib/my_namespace/my_gem.rb" with:
+    """ruby
+    require 'my_namespace/my_gem/version'
+
+    module MyNamespace
+      module MyGem
+      end
+    end
+    """
+    Given a file named "spec/spec_helper.rb" with:
+    """ruby
+    require 'metasploit/version'
+    require 'my_namespace/my_gem'
+
+    # Use find_all_by_name instead of find_by_name as find_all_by_name will return pre-release versions
+    gem_specification = Gem::Specification.find_all_by_name('metasploit-version').first
+
+    Dir[File.join(gem_specification.gem_dir, 'spec', 'support', '**', '*.rb')].each do |f|
+      require f
+    end
+    """
+    Given a file named "spec/lib/my_namespace/my_gem/version_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe MyNamespace::MyGem::Version do
+      it_should_behave_like 'Metasploit::Version Version Module'
+    end
+    """
+    Given I set the environment variables to:
+      | variable            | value  |
+      | TRAVIS_BRANCH       | master |
+      | TRAVIS_PULL_REQUEST | false  |
+  Scenario: PRERELEASE defined
+    Given a file named "lib/my_namespace/my_gem/version.rb" with:
+    """ruby
+    module MyNamespace
+      module MyGem
+        module Version
+          #
+          # CONSTANTS
+          #
+
+          # The major version number
+          MAJOR = 1
+
+          # The minor version number, scoped to the {MAJOR} version number.
+          MINOR = 2
+
+          # The patch number, scoped to the {MINOR} version number
+          PATCH = 3
+
+          # The prerelease name of the given {MAJOR}.{MINOR}.{PATCH} version number.  Will not be defined on master.
+          PRERELEASE = 'source-branch-relative-name'
+        end
+      end
+    end
+    """
+    When I run `rspec spec/lib/my_namespace/my_gem/version_spec.rb --format documentation`
+    Then the output should contain "expected MyNamespace::MyGem::Version::PRERELEASE not to be defined on master"
+  Scenario: PRERELEASE undefined
+    Given a file named "lib/my_namespace/my_gem/version.rb" with:
+    """ruby
+    module MyNamespace
+      module MyGem
+        module Version
+          #
+          # CONSTANTS
+          #
+
+          # The major version number
+          MAJOR = 1
+
+          # The minor version number, scoped to the {MAJOR} version number.
+          MINOR = 2
+
+          # The patch number, scoped to the {MINOR} version number
+          PATCH = 3
+        end
+      end
+    end
+    """
+    When I run `rspec spec/lib/my_namespace/my_gem/version_spec.rb --format documentation`
+    Then the output should not contain "expected MyNamespace::MyGem::Version::PRERELEASE not to be defined on master"

data/features/shared/examples/metasploit/version/version_module/prerelease/travis_ci/pull_request.feature

@@ -0,0 +1,99 @@
+Feature: 'Metasploit::Version Version Module' shared example in pull request build on Travis-CI
+
+  The 'Metasploit::Version Version Module' shared example won't check PRERELEASE for pull request builds on Travis-CI
+  because the code is expected to have PRERELEASE set to the value appropriate to the source branch and not the
+  destination branch being built by the pull request build.
+
+  Background:
+    Given I unset the environment variable "TRAVIS_BRANCH"
+    Given a file named "lib/my_namespace/my_gem.rb" with:
+    """ruby
+    require 'my_namespace/my_gem/version'
+
+    module MyNamespace
+      module MyGem
+      end
+    end
+    """
+    Given a file named "spec/spec_helper.rb" with:
+    """ruby
+    require 'metasploit/version'
+    require 'my_namespace/my_gem'
+
+    # Use find_all_by_name instead of find_by_name as find_all_by_name will return pre-release versions
+    gem_specification = Gem::Specification.find_all_by_name('metasploit-version').first
+
+    Dir[File.join(gem_specification.gem_dir, 'spec', 'support', '**', '*.rb')].each do |f|
+      require f
+    end
+    """
+    Given a file named "spec/lib/my_namespace/my_gem/version_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe MyNamespace::MyGem::Version do
+      it_should_behave_like 'Metasploit::Version Version Module'
+    end
+    """
+    Given I set the environment variables to:
+      | variable      | value  |
+      | TRAVIS_BRANCH | master |
+
+ Scenario: PRERELEASE set to source branch relative name
+    Given a file named "lib/my_namespace/my_gem/version.rb" with:
+    """ruby
+    module MyNamespace
+      module MyGem
+        module Version
+          #
+          # CONSTANTS
+          #
+
+          # The major version number
+          MAJOR = 1
+
+          # The minor version number, scoped to the {MAJOR} version number.
+          MINOR = 2
+
+          # The patch number, scoped to the {MINOR} version number
+          PATCH = 3
+
+          # The prerelease name of the given {MAJOR}.{MINOR}.{PATCH} version number.  Will not be defined on master.
+          PRERELEASE = 'source-branch-relative-name'
+
+          # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+          # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
+          #
+          # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{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 {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+          # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
+          #
+          # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}.{PRERELEASE}' on any branch
+          #   other than master.
+          def self.gem
+            full.gsub('-', '.pre.')
+          end
+        end
+      end
+    end
+    """
+    Given I set the environment variables to:
+      | variable            | value |
+      | TRAVIS_PULL_REQUEST | true  |
+    When I run `rspec spec/lib/my_namespace/my_gem/version_spec.rb --format documentation`
+    Then the output should contain:
+      """
+            PRERELEASE
+              is not defined (PENDING: PRERELEASE can only be set appropriately for a merge by merging to the target branch and then updating PRERELEASE on the target branch before committing and/or pushing to github and travis-ci.)
+      """

data/features/shared/examples/metasploit/version/version_module/prerelease/travis_ci/tag.feature

@@ -0,0 +1,277 @@
+Feature: 'Metasploit::Version Version Module' shared example in tag build on Travis-CI
+
+  The 'Metasploit::Version Version Module' shared example will check that the described_class for an RSpec *_spec.rb
+  file defines PRERELEASE to match the prerelease part of the tag converted from the gem prerelease format.
+
+  Background:
+    Given I set the environment variables to:
+      | variable            | value |
+      | TRAVIS_PULL_REQUEST | false |
+    Given a file named "lib/my_namespace/my_gem.rb" with:
+      """ruby
+      require 'my_namespace/my_gem/version'
+
+      module MyNamespace
+        module MyGem
+        end
+      end
+      """
+    Given a file named "spec/spec_helper.rb" with:
+      """ruby
+      require 'metasploit/version'
+      require 'my_namespace/my_gem'
+
+      # Use find_all_by_name instead of find_by_name as find_all_by_name will return pre-release versions
+      gem_specification = Gem::Specification.find_all_by_name('metasploit-version').first
+
+      Dir[File.join(gem_specification.gem_dir, 'spec', 'support', '**', '*.rb')].each do |f|
+        require f
+      end
+      """
+    Given a file named "spec/lib/my_namespace/my_gem/version_spec.rb" with:
+      """ruby
+      require 'spec_helper'
+
+      RSpec.describe MyNamespace::MyGem::Version do
+        it_should_behave_like 'Metasploit::Version Version Module'
+      end
+      """
+
+  Scenario Outline: PRERELEASE defined as tag relative name
+    Given a file named "lib/my_namespace/my_gem/version.rb" with:
+      """ruby
+      module MyNamespace
+        module MyGem
+          module Version
+            #
+            # CONSTANTS
+            #
+
+            # The major version number
+            MAJOR = 1
+
+            # The minor version number, scoped to the {MAJOR} version number.
+            MINOR = 2
+
+            # The patch number, scoped to the {MINOR} version number
+            PATCH = 3
+
+            # The prerelease name of the given {MAJOR}.{MINOR}.{PATCH} version number.  Will not be defined on master.
+            PRERELEASE = '<prerelease>'
+
+            # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+            # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
+            #
+            # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{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 {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+            # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
+            #
+            # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}.{PRERELEASE}' on any branch
+            #   other than master.
+            def self.gem
+              full.gsub('-', '.pre.')
+            end
+          end
+        end
+      end
+      """
+    Given I set the environment variables to:
+      | variable      | value     |
+      | TRAVIS_BRANCH | <tag>  |
+    When I run `rspec spec/lib/my_namespace/my_gem/version_spec.rb --format documentation`
+    Then the output should contain:
+      """
+            PRERELEASE
+              matches the tag prerelease converted from a gem version to a VERSION
+      """
+
+    Examples:
+      | prerelease | tag                       |
+      | nasty      | v1.2.3.pre.nasty          |
+      | super-cool | v1.2.3.pre.super.pre.cool |
+
+  Scenario Outline: PRERELEASE not defined as tag relative name
+    Given a file named "lib/my_namespace/my_gem/version.rb" with:
+      """ruby
+      module MyNamespace
+        module MyGem
+          module Version
+            #
+            # CONSTANTS
+            #
+
+            # The major version number
+            MAJOR = 1
+
+            # The minor version number, scoped to the {MAJOR} version number.
+            MINOR = 2
+
+            # The patch number, scoped to the {MINOR} version number
+            PATCH = 3
+
+            # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+            # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
+            #
+            # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{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 {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+            # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
+            #
+            # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}.{PRERELEASE}' on any branch
+            #   other than master.
+            def self.gem
+              full.gsub('-', '.pre.')
+            end
+          end
+        end
+      end
+      """
+    Given I set the environment variables to:
+      | variable      | value     |
+      | TRAVIS_BRANCH | <tag>  |
+    When I run `rspec spec/lib/my_namespace/my_gem/version_spec.rb --format documentation`
+    Then the output should contain "MyNamespace::MyGem::Version it should behave like Metasploit::Version Version Module CONSTANTS PRERELEASE matches the tag prerelease converted from a gem version to a VERSION"
+    And the output should contain:
+      """
+             expected MyNamespace::MyGem::Version::PRERELEASE to be defined.
+             Add the following to MyNamespace::MyGem::Version:
+      """
+    # Can't do a continuous multiline string because editors will truncate whitespace in blank line and it won't match
+    # whitespace in rspec output.
+    And the output should contain:
+      """
+                 # The prerelease version, scoped to the {PATCH} version number.
+                 PRERELEASE = <prerelease>
+      """
+
+    Examples:
+      | prerelease | tag                       |
+      | nasty      | v1.2.3.pre.nasty          |
+      | super-cool | v1.2.3.pre.super.pre.cool |
+
+  Scenario: PRERELEASE defined on release tag
+    Given a file named "lib/my_namespace/my_gem/version.rb" with:
+      """ruby
+      module MyNamespace
+        module MyGem
+          module Version
+            #
+            # CONSTANTS
+            #
+
+            # The major version number
+            MAJOR = 1
+
+            # The minor version number, scoped to the {MAJOR} version number.
+            MINOR = 2
+
+            # The patch number, scoped to the {MINOR} version number
+            PATCH = 3
+
+            # The prerelease name of the given {MAJOR}.{MINOR}.{PATCH} version number.  Will not be defined on master.
+            PRERELEASE = 'left-over-from-branch'
+
+            # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+            # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
+            #
+            # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{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 {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+            # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
+            #
+            # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}.{PRERELEASE}' on any branch
+            #   other than master.
+            def self.gem
+              full.gsub('-', '.pre.')
+            end
+          end
+        end
+      end
+      """
+    Given I set the environment variables to:
+      | variable      | value  |
+      | TRAVIS_BRANCH | v1.2.3 |
+    When I run `rspec spec/lib/my_namespace/my_gem/version_spec.rb --format documentation`
+    Then the output should contain "expected MyNamespace::MyGem::Version::PRERELEASE not to be defined on master"
+
+  Scenario: PRERELEASE not defined on release tag
+    Given a file named "lib/my_namespace/my_gem/version.rb" with:
+      """ruby
+      module MyNamespace
+        module MyGem
+          module Version
+            #
+            # CONSTANTS
+            #
+
+            # The major version number
+            MAJOR = 1
+
+            # The minor version number, scoped to the {MAJOR} version number.
+            MINOR = 2
+
+            # The patch number, scoped to the {MINOR} version number
+            PATCH = 3
+
+            # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+            # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
+            #
+            # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{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 {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+            # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
+            #
+            # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}.{PRERELEASE}' on any branch
+            #   other than master.
+            def self.gem
+              full.gsub('-', '.pre.')
+            end
+          end
+        end
+      end
+      """
+    Given I set the environment variables to:
+      | variable      | value  |
+      | TRAVIS_BRANCH | v1.2.3 |
+    Then I successfully run `rspec spec/lib/my_namespace/my_gem/version_spec.rb --format documentation`