crowbar/crowbar-core

View on GitHub
crowbar_framework/app/controllers/api/upgrade_controller.rb

Summary

Maintainability
F
3 days
Test Coverage

File upgrade_controller.rb has 668 lines of code (exceeds 250 allowed). Consider refactoring.
Open

class Api::UpgradeController < ApiController
  # disable upgrade API until upgrade to next version is implemented
  before_action(except: :show) do
    # skip filter if we're in the middle of upgrade from previos version
    unless File.exist?("/var/lib/crowbar/upgrade/8-to-9-upgrade-running")
Severity: Major
Found in crowbar_framework/app/controllers/api/upgrade_controller.rb - About 1 day to fix

Method nodes has a Cognitive Complexity of 61 (exceeds 5 allowed). Consider refactoring.
Open

  def nodes
    if params[:component]
      component = params[:component]
      upgrade_status = ::Crowbar::UpgradeStatus.new
      substep = upgrade_status.current_substep
Severity: Minor
Found in crowbar_framework/app/controllers/api/upgrade_controller.rb - About 1 day 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 nodes has 96 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def nodes
    if params[:component]
      component = params[:component]
      upgrade_status = ::Crowbar::UpgradeStatus.new
      substep = upgrade_status.current_substep
Severity: Major
Found in crowbar_framework/app/controllers/api/upgrade_controller.rb - About 3 hrs to fix

Method adminbackup has 43 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def adminbackup
    # FIXME: move this logic into the model
    upgrade_status = ::Crowbar::UpgradeStatus.new
    upgrade_status.start_step(:backup_crowbar)
    @backup = Api::Backup.new(backup_params)
Severity: Minor
Found in crowbar_framework/app/controllers/api/upgrade_controller.rb - About 1 hr to fix

Method adminrepocheck has 32 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def adminrepocheck
    check = Api::Upgrade.adminrepocheck

    if check.key?(:error)
      render json: {
Severity: Minor
Found in crowbar_framework/app/controllers/api/upgrade_controller.rb - About 1 hr to fix

Method cancel has 31 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def cancel
    if Api::Upgrade.cancel
      head :ok
    else
      render json: {
Severity: Minor
Found in crowbar_framework/app/controllers/api/upgrade_controller.rb - About 1 hr to fix

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

  def adminbackup
    # FIXME: move this logic into the model
    upgrade_status = ::Crowbar::UpgradeStatus.new
    upgrade_status.start_step(:backup_crowbar)
    @backup = Api::Backup.new(backup_params)
Severity: Minor
Found in crowbar_framework/app/controllers/api/upgrade_controller.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

  rescue ::Crowbar::Error::StartStepRunningError,
         ::Crowbar::Error::StartStepOrderError,
         ::Crowbar::Error::SaveUpgradeStatusError => e
    render json: {
      errors: {
Severity: Minor
Found in crowbar_framework/app/controllers/api/upgrade_controller.rb and 1 other location - About 25 mins to fix
crowbar_framework/app/controllers/api/upgrade_controller.rb on lines 109..120

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 30.

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

  rescue ::Crowbar::Error::StartStepRunningError,
         ::Crowbar::Error::StartStepOrderError,
         ::Crowbar::Error::SaveUpgradeStatusError => e
    render json: {
      errors: {
Severity: Minor
Found in crowbar_framework/app/controllers/api/upgrade_controller.rb and 1 other location - About 25 mins to fix
crowbar_framework/app/controllers/api/upgrade_controller.rb on lines 130..141

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 30.

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