serverspec/serverspec

View on GitHub
lib/serverspec/setup.rb

Summary

Maintainability
D
1 day
Test Coverage

File setup.rb has 297 lines of code (exceeds 250 allowed). Consider refactoring.
Open

require 'pathname'
require 'fileutils'
require 'erb'

module Serverspec
Severity: Minor
Found in lib/serverspec/setup.rb - About 3 hrs to fix

    Method spec_helper_template has 60 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        def self.spec_helper_template
          template = <<-'EOF'
    require 'serverspec'
    <% if @backend_type == 'ssh' -%>
    require 'net/ssh'
    Severity: Major
    Found in lib/serverspec/setup.rb - About 2 hrs to fix

      Method auto_vagrant_configuration has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
      Open

          def self.auto_vagrant_configuration
            if find_vagrantfile
              vagrant_list = `vagrant status`
              list_of_vms = []
              if vagrant_list != ''
      Severity: Minor
      Found in lib/serverspec/setup.rb - About 1 hr to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Method safe_create_rakefile has 36 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          def self.safe_create_rakefile
            content = <<-'EOF'
      require 'rake'
      require 'rspec/core/rake_task'
      
      
      Severity: Minor
      Found in lib/serverspec/setup.rb - About 1 hr to fix

        Method run has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
        Open

            def self.run
        
              ask_os_type
        
              if @os_type == 'UN*X'
        Severity: Minor
        Found in lib/serverspec/setup.rb - About 1 hr to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Method run has 35 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            def self.run
        
              ask_os_type
        
              if @os_type == 'UN*X'
        Severity: Minor
        Found in lib/serverspec/setup.rb - About 1 hr to fix

          Method safe_create_spec has 35 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              def self.safe_create_spec
                content = <<-EOF
          require 'spec_helper'
          
          describe package('httpd'), :if => os[:family] == 'redhat' do
          Severity: Minor
          Found in lib/serverspec/setup.rb - About 1 hr to fix

            Method safe_create_spec_helper has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

                def self.safe_create_spec_helper
                  erb = if RUBY_VERSION >= "2.6"
                          ERB.new(spec_helper_template, :trim_mode => '-')
                        else
                          ERB.new(spec_helper_template, nil, '-')
            Severity: Minor
            Found in lib/serverspec/setup.rb - About 25 mins to fix

            Cognitive Complexity

            Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

            A method's cognitive complexity is based on a few simple rules:

            • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
            • Code is considered more complex for each "break in the linear flow of the code"
            • Code is considered more complex when "flow breaking structures are nested"

            Further reading

            Similar blocks of code found in 2 locations. Consider refactoring.
            Open

                def self.safe_create_dotrspec
                  content = <<-'EOF'
            --color
            --format documentation
                  EOF
            Severity: Minor
            Found in lib/serverspec/setup.rb and 1 other location - About 30 mins to fix
            lib/serverspec/setup.rb on lines 174..213

            Duplicated Code

            Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

            Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

            When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

            Tuning

            This issue has a mass of 33.

            We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

            The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

            If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

            See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

            Refactorings

            Further Reading

            Similar blocks of code found in 2 locations. Consider refactoring.
            Open

                def self.safe_create_rakefile
                  content = <<-'EOF'
            require 'rake'
            require 'rspec/core/rake_task'
            
            
            Severity: Minor
            Found in lib/serverspec/setup.rb and 1 other location - About 30 mins to fix
            lib/serverspec/setup.rb on lines 337..351

            Duplicated Code

            Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

            Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

            When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

            Tuning

            This issue has a mass of 33.

            We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

            The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

            If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

            See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

            Refactorings

            Further Reading

            There are no issues that match your filters.

            Category
            Status