tomlobato/sys_watchdog

View on GitHub

Showing 250 of 250 total issues

Class has too many lines. [119/100]
Open

class Setup
  SYSTEMD_SERVICES_DIR = "/lib/systemd/system/"
  SYSTEMD_SERVICE_FILE = "#{SYSTEMD_SERVICES_DIR}/sys-watchdog.service"

  def initialize
Severity: Minor
Found in lib/sys_watchdog/setup.rb by rubocop

This cop checks if the length a class exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Method has too many lines. [16/10]
Open

    def run_test test, after_restore: false
        new_status, _exitstatus, output = test.run

        notify_output_change test, output

Severity: Minor
Found in lib/sys_watchdog/main.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Method has too many lines. [13/10]
Open

    def check_result exitstatus, output
        success = 
            if @expected_regex
                output =~ @expected_regex
            elsif @expected_string
Severity: Minor
Found in lib/sys_watchdog/wd_test.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Method has too many lines. [13/10]
Open

    def initialize name, params, logger
        @logger = logger

        @name = name

Severity: Minor
Found in lib/sys_watchdog/wd_test.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Method has too many lines. [12/10]
Open

    def setup
        if @conf.slack_token
            Slack.configure do |config|
              config.token = @conf.slack_token
            end
Severity: Minor
Found in lib/sys_watchdog/main.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Method has too many lines. [12/10]
Open

  def setup
    check_root
    copy_sample_conf
    create_working_dir
    install_type = get_install_type
Severity: Minor
Found in lib/sys_watchdog/setup.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Perceived complexity for run_test is too high. [9/7]
Open

    def run_test test, after_restore: false
        new_status, _exitstatus, output = test.run

        notify_output_change test, output

Severity: Minor
Found in lib/sys_watchdog/main.rb by rubocop

This cop tries to produce a complexity score that's a measure of the complexity the reader experiences when looking at a method. For that reason it considers when nodes as something that doesn't add as much complexity as an if or a &&. Except if it's one of those special case/when constructs where there's no expression after case. Then the cop treats it as an if/elsif/elsif... and lets all the when nodes count. In contrast to the CyclomaticComplexity cop, this cop considers else nodes as adding complexity.

Example:

def my_method                   # 1
  if cond                       # 1
    case var                    # 2 (0.8 + 4 * 0.2, rounded)
    when 1 then func_one
    when 2 then func_two
    when 3 then func_three
    when 4..10 then func_other
    end
  else                          # 1
    do_something until a && b   # 2
  end                           # ===
end                             # 7 complexity points

Cyclomatic complexity for run_test is too high. [7/6]
Open

    def run_test test, after_restore: false
        new_status, _exitstatus, output = test.run

        notify_output_change test, output

Severity: Minor
Found in lib/sys_watchdog/main.rb by rubocop

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Method has too many lines. [11/10]
Open

  def install_systemd_service
    if `which systemctl`.strip.empty?
      STDERR.puts "SysWatchdog install requires systemctl. Aborting."
      exit 1
    end
Severity: Minor
Found in lib/sys_watchdog/setup.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Method has too many lines. [11/10]
Open

    def send_mail sub, body
        @logger.info "Sending email: #{ sub }"

        body ||= ""
        body += append_sys_info
Severity: Minor
Found in lib/sys_watchdog/notify.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Method has too many lines. [11/10]
Open

  def uninstall
    stop
    File.delete SysWatchdog::DEFAULT_CONF_FILE
    if File.exist?(SYSTEMD_SERVICE_FILE)
      run 'systemctl disable sys-watchdog'
Severity: Minor
Found in lib/sys_watchdog/setup.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Assignment Branch Condition size for run_test is too high. [15.52/15]
Open

    def run_test test, after_restore: false
        new_status, _exitstatus, output = test.run

        notify_output_change test, output

Severity: Minor
Found in lib/sys_watchdog/main.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

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

    def run_test test, after_restore: false
        new_status, _exitstatus, output = test.run

        notify_output_change test, output

Severity: Minor
Found in lib/sys_watchdog/main.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 check_conf_file has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    def check_conf_file conf_file
        unless File.readable? conf_file
            raise "Conf file #{conf_file} not found or unreadable. Aborting." 
        end

Severity: Minor
Found in lib/sys_watchdog/main.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

Prefer single-quoted strings when you don't need string interpolation or special symbols.
Open

  s.add_dependency("slack-ruby-client", "~> 0.8.1")
Severity: Minor
Found in sys_watchdog.gemspec by rubocop

Checks if uses of quotes match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
"No special symbols"
"No string interpolation"
"Just text"

# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

Example: EnforcedStyle: double_quotes

# bad
'Just some text'
'No special chars or interpolation'

# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"

Missing top-level class documentation comment.
Open

class WdLogger < Logger
Severity: Minor
Found in lib/sys_watchdog/wd_logger.rb by rubocop

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Trailing whitespace detected.
Open

  
Severity: Minor
Found in lib/sys_watchdog/setup.rb by rubocop

Favor modifier if usage when having a single-line body. Another good alternative is the usage of control flow &&/||.
Open

        if @notify_on_output_change
Severity: Minor
Found in lib/sys_watchdog/wd_test.rb by rubocop

Checks for if and unless statements that would fit on one line if written as a modifier if/unless. The maximum line length is configured in the Metrics/LineLength cop.

Example:

# bad
if condition
  do_stuff(bar)
end

unless qux.empty?
  Foo.do_something
end

# good
do_stuff(bar) if condition
Foo.do_something unless qux.empty?

Use && instead of and.
Open

  (stat.uid == Process.uid and stat.gid == Process.gid)
Severity: Minor
Found in lib/sys_watchdog/core_extensions.rb by rubocop

This cop checks for uses of and and or, and suggests using && and || instead. It can be configured to check only in conditions, or in all contexts.

Example: EnforcedStyle: always (default)

# bad
foo.save and return

# bad
if foo and bar
end

# good
foo.save && return

# good
if foo && bar
end

Example: EnforcedStyle: conditionals

# bad
if foo and bar
end

# good
foo.save && return

# good
foo.save and return

# good
if foo && bar
end

Missing top-level class documentation comment.
Open

class Exception
Severity: Minor
Found in lib/sys_watchdog/core_extensions.rb by rubocop

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end
Severity
Category
Status
Source
Language