Sign upLogin

theforeman/foreman_remote_execution

View on GitHub
Star
.rubocop_todo.yml

Summary

Maintainability
Test Coverage
# This configuration was generated by
# `rubocop --auto-gen-config`
# on 2020-12-02 23:05:20 UTC using RuboCop version 1.5.1.
# The point is for the user to remove these configuration records
# one by one as the offenses are removed from the code base.
# Note that changes in the inspected code, or installation of new
# versions of RuboCop, may require this file to be generated again.

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyleAlignWith, Severity.
# SupportedStylesAlignWith: start_of_line, begin
Layout/BeginEndAlignment:
  Exclude:
    - 'lib/foreman_remote_execution_core/script_runner.rb'

# Offense count: 13
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, IndentOneStep, IndentationWidth.
# SupportedStyles: case, end
Layout/CaseIndentation:
  Exclude:
    - 'app/controllers/job_invocations_controller.rb'
    - 'app/controllers/job_templates_controller.rb'
    - 'app/models/host_status/execution_status.rb'

# Offense count: 4
# Cop supports --auto-correct.
Layout/EmptyLines:
  Exclude:
    - 'app/models/template_invocation.rb'
    - 'test/unit/input_template_renderer_test.rb'
    - 'test/unit/job_invocation_composer_test.rb'
    - 'test/unit/remote_execution_feature_test.rb'

# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: AllowAliasSyntax, AllowedMethods.
# AllowedMethods: alias_method, public, protected, private
Layout/EmptyLinesAroundAttributeAccessor:
  Exclude:
    - 'app/lib/foreman_remote_execution/renderer/scope/input.rb'
    - 'app/models/job_invocation_composer.rb'

# Offense count: 6
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: empty_lines, no_empty_lines
Layout/EmptyLinesAroundBlockBody:
  Exclude:
    - 'extra/cockpit/foreman-cockpit-session'
    - 'test/unit/input_template_renderer_test.rb'
    - 'test/unit/job_invocation_composer_test.rb'
    - 'test/unit/targeting_test.rb'

# Offense count: 21
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines, beginning_only, ending_only
Layout/EmptyLinesAroundClassBody:
  Enabled: false

# Offense count: 4
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
Layout/EmptyLinesAroundModuleBody:
  Exclude:
    - 'app/helpers/concerns/foreman_remote_execution/hosts_helper_extensions.rb'
    - 'app/lib/actions/middleware/bind_job_invocation.rb'
    - 'test/functional/api/v2/job_templates_controller_test.rb'

# Offense count: 6
# Cop supports --auto-correct.
# Configuration parameters: Width, IgnoredPatterns.
Layout/IndentationWidth:
  Exclude:
    - 'app/models/template_invocation.rb'
    - 'extra/cockpit/foreman-cockpit-session'

# Offense count: 7
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, IndentationWidth.
# SupportedStyles: aligned, indented
Layout/MultilineOperationIndentation:
  Exclude:
    - 'app/helpers/job_invocations_helper.rb'
    - 'app/helpers/remote_execution_helper.rb'
    - 'app/models/job_invocation_composer.rb'
    - 'app/models/remote_execution_provider.rb'
    - 'lib/foreman_remote_execution_core/dispatcher.rb'

# Offense count: 7
# Cop supports --auto-correct.
Layout/SpaceAfterComma:
  Exclude:
    - 'app/helpers/job_invocation_output_helper.rb'
    - 'db/migrate/20200623073022_rename_sudo_password_to_effective_user_password.rb'
    - 'test/functional/ui_job_wizard_controller_test.rb'
    - 'test/unit/job_invocation_composer_test.rb'

# Offense count: 29
# Cop supports --auto-correct.
# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
# SupportedStylesForExponentOperator: space, no_space
Layout/SpaceAroundOperators:
  Exclude:
    - 'app/controllers/ui_job_wizard_controller.rb'
    - 'app/helpers/job_invocations_helper.rb'
    - 'db/migrate/20150708133242_add_invocation.rb'
    - 'extra/cockpit/foreman-cockpit-session'
    - 'test/helpers/remote_execution_helper_test.rb'
    - 'test/unit/input_template_renderer_test.rb'
    - 'test/unit/job_invocation_composer_test.rb'

# Offense count: 58
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBrackets.
# SupportedStyles: space, no_space, compact
# SupportedStylesForEmptyBrackets: space, no_space
Layout/SpaceInsideArrayLiteralBrackets:
  Exclude:
    - 'app/helpers/concerns/foreman_remote_execution/hosts_helper_extensions.rb'
    - 'app/helpers/remote_execution_helper.rb'
    - 'app/lib/actions/remote_execution/run_host_job.rb'
    - 'app/models/host_status/execution_status.rb'
    - 'app/models/job_invocation.rb'
    - 'app/models/job_invocation_composer.rb'
    - 'app/models/job_template.rb'
    - 'app/models/remote_execution_feature.rb'
    - 'extra/cockpit/foreman-cockpit-session'
    - 'lib/foreman_remote_execution/engine.rb'
    - 'test/unit/execution_task_status_mapper_test.rb'
    - 'test/unit/job_invocation_composer_test.rb'
    - 'test/unit/targeting_test.rb'

# Offense count: 2
# Configuration parameters: AllowedMethods.
# AllowedMethods: enums
Lint/ConstantDefinitionInBlock:
  Exclude:
    - 'lib/foreman_remote_execution/engine.rb'

# Offense count: 2
Lint/MissingSuper:
  Exclude:
    - 'app/services/ui_notifications/remote_execution_jobs/base_job_finish.rb'
    - 'lib/foreman_remote_execution_core/log_filter.rb'

# Offense count: 10
# Cop supports --auto-correct.
# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
Lint/UnusedBlockArgument:
  Exclude:
    - 'app/models/job_invocation_composer.rb'
    - 'extra/cockpit/foreman-cockpit-session'
    - 'lib/foreman_remote_execution/engine.rb'
    - 'lib/foreman_remote_execution_core/script_runner.rb'
    - 'test/factories/foreman_remote_execution_factories.rb'

# Offense count: 15
# Cop supports --auto-correct.
# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
Lint/UnusedMethodArgument:
  Exclude:
    - 'app/helpers/concerns/foreman_remote_execution/hosts_helper_extensions.rb'
    - 'app/helpers/remote_execution_helper.rb'
    - 'app/lib/actions/remote_execution/run_host_job.rb'
    - 'app/models/host_status/execution_status.rb'
    - 'app/models/job_invocation.rb'
    - 'app/models/job_invocation_composer.rb'
    - 'app/models/job_template.rb'
    - 'app/models/remote_execution_provider.rb'
    - 'lib/foreman_remote_execution_core/script_runner.rb'
    - 'test/benchmark/run_hosts_job_benchmark.rb'
    - 'test/support/remote_execution_helper.rb'

# Offense count: 4
Lint/UselessAssignment:
  Exclude:
    - 'app/lib/foreman_remote_execution/renderer/scope/input.rb'
    - 'app/models/job_template.rb'
    - 'app/models/remote_execution_feature.rb'
    - 'extra/cockpit/foreman-cockpit-session'

# Offense count: 31
# Cop supports --auto-correct.
Minitest/GlobalExpectations:
  Exclude:
    - 'test/helpers/remote_execution_helper_test.rb'
    - 'test/unit/actions/run_hosts_job_test.rb'
    - 'test/unit/concerns/foreman_tasks_cleaner_extensions_test.rb'
    - 'test/unit/concerns/host_extensions_test.rb'
    - 'test/unit/job_invocation_test.rb'
    - 'test/unit/remote_execution_provider_test.rb'
    - 'test/unit/targeting_test.rb'

# Offense count: 2
Naming/AccessorMethodName:
  Exclude:
    - 'app/lib/actions/remote_execution/run_hosts_job.rb'
    - 'app/models/concerns/foreman_remote_execution/host_extensions.rb'

# Offense count: 6
# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, Regex, IgnoreExecutableScripts, AllowedAcronyms.
# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
Naming/FileName:
  Exclude:
    - 'db/seeds.d/100-assign_features_with_templates.rb'
    - 'db/seeds.d/20-permissions.rb'
    - 'db/seeds.d/50-notification_blueprints.rb'
    - 'db/seeds.d/60-ssh_proxy_feature.rb'
    - 'db/seeds.d/70-job_templates.rb'
    - 'db/seeds.d/90-bookmarks.rb'
    - 'db/seeds.d/95-mail_notifications.rb'

# Offense count: 1
# Configuration parameters: ForbiddenDelimiters.
# ForbiddenDelimiters: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
Naming/HeredocDelimiterNaming:
  Exclude:
    - 'lib/foreman_remote_execution_core/fake_script_runner.rb'

# Offense count: 2
# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
# AllowedNames: at, by, db, id, in, io, ip, of, on, os, pp, to
Naming/MethodParameterName:
  Exclude:
    - 'app/helpers/remote_execution_helper.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: PreferredName.
Naming/RescuedExceptionsVariableName:
  Exclude:
    - 'Rakefile'

# Offense count: 1
# Configuration parameters: MinSize.
Performance/CollectionLiteralInLoop:
  Exclude:
    - 'db/seeds.d/90-bookmarks.rb'

# Offense count: 11
# Cop supports --auto-correct.
Rails/ContentTag:
  Exclude:
    - 'app/helpers/job_invocations_helper.rb'
    - 'app/helpers/remote_execution_helper.rb'

# Offense count: 7
# Configuration parameters: Include.
# Include: db/migrate/*.rb
Rails/CreateTableWithTimestamps:
  Exclude:
    - 'db/migrate/20150708133241_add_targeting.rb'
    - 'db/migrate/20150708133242_add_invocation.rb'
    - 'db/migrate/20150708133305_add_template_invocation.rb'
    - 'db/migrate/20151124162300_create_job_template_effective_users.rb'
    - 'db/migrate/20160108134600_create_template_input_sets.rb'
    - 'db/migrate/20160118124600_create_remote_execution_features.rb'

# Offense count: 1
# Configuration parameters: EnforcedStyle.
# SupportedStyles: strict, flexible
Rails/Date:
  Exclude:
    - 'foreman_remote_execution.gemspec'

# Offense count: 11
# Configuration parameters: Include.
# Include: app/helpers/**/*.rb
Rails/HelperInstanceVariable:
  Exclude:
    - 'app/helpers/job_invocation_output_helper.rb'
    - 'app/helpers/job_invocations_chart_helper.rb'
    - 'app/helpers/remote_execution_helper.rb'

# Offense count: 13
# Configuration parameters: Include.
# Include: app/models/**/*.rb
Rails/InverseOf:
  Exclude:
    - 'app/models/concerns/foreman_remote_execution/foreman_tasks_task_extensions.rb'
    - 'app/models/concerns/foreman_remote_execution/foreman_tasks_triggering_extensions.rb'
    - 'app/models/concerns/foreman_remote_execution/host_extensions.rb'
    - 'app/models/concerns/foreman_remote_execution/template_extensions.rb'
    - 'app/models/job_invocation_task_group.rb'
    - 'app/models/job_template.rb'
    - 'app/models/template_invocation.rb'

# Offense count: 1
# Configuration parameters: Include.
# Include: app/controllers/**/*.rb
Rails/LexicallyScopedActionFilter:
  Exclude:
    - 'app/controllers/api/v2/job_invocations_controller.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: Include.
# Include: **/Rakefile, **/*.rake
Rails/RakeEnvironment:
  Exclude:
    - 'lib/tasks/foreman_remote_execution_tasks.rake'

# Offense count: 3
# Cop supports --auto-correct.
Rails/RedundantForeignKey:
  Exclude:
    - 'app/models/job_template.rb'
    - 'app/models/template_invocation.rb'

# Offense count: 1
Rails/ReflectionClassName:
  Exclude:
    - 'app/models/job_template.rb'

# Offense count: 4
# Configuration parameters: ForbiddenMethods, AllowedMethods.
# ForbiddenMethods: decrement!, decrement_counter, increment!, increment_counter, insert, insert!, insert_all, insert_all!, toggle!, touch, touch_all, update_all, update_attribute, update_column, update_columns, update_counters, upsert, upsert_all
Rails/SkipsModelValidations:
  Exclude:
    - 'app/lib/actions/middleware/bind_job_invocation.rb'
    - 'app/models/concerns/foreman_remote_execution/smart_proxy_extensions.rb'
    - 'test/unit/input_template_renderer_test.rb'
    - 'test/unit/job_invocation_composer_test.rb'

# Offense count: 6
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: strict, flexible
Rails/TimeZone:
  Exclude:
    - 'app/models/job_invocation_composer.rb'
    - 'test/functional/api/v2/job_invocations_controller_test.rb'
    - 'test/unit/job_invocation_composer_test.rb'

# Offense count: 2
# Cop supports --auto-correct.
Style/CaseLikeIf:
  Exclude:
    - 'app/lib/actions/remote_execution/run_host_job.rb'
    - 'app/models/job_invocation_composer.rb'

# Offense count: 5
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: nested, compact
Style/ClassAndModuleChildren:
  Exclude:
    - 'app/controllers/foreman_remote_execution/concerns/api/v2/registration_controller_extensions.rb'
    - 'app/controllers/foreman_remote_execution/concerns/api/v2/subnets_controller_extensions.rb'
    - 'app/models/concerns/foreman_remote_execution/orchestration/ssh.rb'
    - 'app/models/host_status/execution_status.rb'
    - 'app/models/setting/remote_execution.rb'

# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: IgnoredMethods.
# IgnoredMethods: ==, equal?, eql?
Style/ClassEqualityComparison:
  Exclude:
    - 'app/helpers/job_invocations_chart_helper.rb'
    - 'app/helpers/remote_execution_helper.rb'
    - 'app/models/ssh_execution_provider.rb'

# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: Keywords.
# Keywords: TODO, FIXME, OPTIMIZE, HACK, REVIEW, NOTE
Style/CommentAnnotation:
  Exclude:
    - 'app/models/job_invocation_composer.rb'
    - 'db/seeds.d/90-bookmarks.rb'

# Offense count: 1
# Cop supports --auto-correct.
Style/Encoding:
  Exclude:
    - 'foreman_remote_execution_core.gemspec'

# Offense count: 8
# Cop supports --auto-correct.
Style/ExpandPathArguments:
  Exclude:
    - 'Rakefile'
    - 'foreman_remote_execution.gemspec'
    - 'foreman_remote_execution_core.gemspec'
    - 'lib/foreman_remote_execution/engine.rb'
    - 'lib/foreman_remote_execution_core/polling_script_runner.rb'
    - 'test/benchmark/run_hosts_job_benchmark.rb'
    - 'test/benchmark/targeting_benchmark.rb'

# Offense count: 12
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: format, sprintf, percent
Style/FormatString:
  Exclude:
    - 'app/controllers/api/v2/job_invocations_controller.rb'
    - 'app/controllers/job_templates_controller.rb'
    - 'app/helpers/job_invocations_chart_helper.rb'
    - 'app/lib/actions/remote_execution/run_host_job.rb'
    - 'app/lib/actions/remote_execution/run_hosts_job.rb'
    - 'app/models/job_invocation_composer.rb'
    - 'app/models/remote_execution_provider.rb'
    - 'app/models/ssh_execution_provider.rb'
    - 'extra/cockpit/foreman-cockpit-session'

# Offense count: 61
# Configuration parameters: MaxUnannotatedPlaceholdersAllowed.
# SupportedStyles: annotated, template, unannotated
Style/FormatStringToken:
  EnforcedStyle: template

# Offense count: 23
# Configuration parameters: MinBodyLength.
Style/GuardClause:
  Enabled: false

# Offense count: 1
# Cop supports --auto-correct.
Style/HashEachMethods:
  Exclude:
    - 'app/models/concerns/foreman_remote_execution/errors_flattener.rb'

# Offense count: 6
# Configuration parameters: AllowedMethods.
# AllowedMethods: respond_to_missing?
Style/OptionalBooleanParameter:
  Exclude:
    - 'app/helpers/job_invocations_chart_helper.rb'
    - 'app/models/concerns/foreman_remote_execution/host_extensions.rb'
    - 'app/models/input_template_renderer.rb'
    - 'app/models/job_invocation.rb'
    - 'app/models/job_invocation_composer.rb'

# Offense count: 29
# Cop supports --auto-correct.
# Configuration parameters: PreferredDelimiters.
Style/PercentLiteralDelimiters:
  Enabled: false

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: AllowedCompactTypes.
# SupportedStyles: compact, exploded
Style/RaiseArgs:
  EnforcedStyle: exploded

# Offense count: 1
# Cop supports --auto-correct.
Style/RedundantBegin:
  Exclude:
    - 'extra/cockpit/foreman-cockpit-session'

# Offense count: 16
# Cop supports --auto-correct.
# Configuration parameters: AllowMultipleReturnValues.
Style/RedundantReturn:
  Exclude:
    - 'app/helpers/remote_execution_helper.rb'
    - 'app/models/concerns/foreman_remote_execution/errors_flattener.rb'
    - 'app/models/foreign_input_set.rb'
    - 'app/models/host_status/execution_status.rb'
    - 'app/models/job_invocation.rb'
    - 'extra/cockpit/foreman-cockpit-session'
    - 'lib/foreman_remote_execution_core/polling_script_runner.rb'
    - 'lib/foreman_remote_execution_core/script_runner.rb'
    - 'test/support/remote_execution_helper.rb'

# Offense count: 79
# Cop supports --auto-correct.
Style/RedundantSelf:
  Enabled: false

# Offense count: 3
# Cop supports --auto-correct.
Style/RescueModifier:
  Exclude:
    - 'extra/cockpit/foreman-cockpit-session'
    - 'lib/foreman_remote_execution/engine.rb'

# Offense count: 13
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: implicit, explicit
Style/RescueStandardError:
  Exclude:
    - 'Rakefile'
    - 'app/lib/actions/remote_execution/run_host_job.rb'
    - 'app/lib/proxy_api/remote_execution_ssh.rb'
    - 'app/models/concerns/foreman_remote_execution/orchestration/ssh.rb'
    - 'app/models/input_template_renderer.rb'
    - 'app/models/job_invocation_composer.rb'
    - 'lib/foreman_remote_execution_core/polling_script_runner.rb'
    - 'lib/foreman_remote_execution_core/script_runner.rb'
    - 'lib/tasks/foreman_remote_execution_tasks.rake'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: AllowModifier.
Style/SoleNestedConditional:
  Exclude:
    - 'app/helpers/concerns/foreman_remote_execution/job_templates_extensions.rb'

# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: IgnoredMethods.
# IgnoredMethods: respond_to, define_method
Style/SymbolProc:
  Exclude:
    - 'app/models/concerns/foreman_remote_execution/foreman_tasks_cleaner_extensions.rb'
    - 'app/models/concerns/foreman_remote_execution/host_extensions.rb'
    - 'app/models/job_invocation_composer.rb'