Uploaded image for project: 'Rules Repository'
  1. Rules Repository
  2. RSPEC-1751

Loops with at most one iteration should be refactored

    Details

    • Type: Bug Detection
    • Status: Active
    • Resolution: Unresolved
    • Labels:
      None
    • Message:
      Refactor this loop to do more than one iteration.
    • Highlighting:
      Hide
      • primary: first line of the loop statement
      • secondary: all the nested control flow statements return, break, throw or goto leading to have at most one iteration
        message: 'The loop stops here.'
      Show
      primary: first line of the loop statement secondary: all the nested control flow statements return , break , throw or goto leading to have at most one iteration message: 'The loop stops here.'
    • Default Severity:
      Major
    • Impact:
      Low
    • Likelihood:
      High
    • Default Quality Profiles:
      Sonar way
    • Targeted languages:
      Cobol, Flex, PL/I, RPG, VB6
    • Covered Languages:
      ABAP, C#, C, C++, Go, Java, JavaScript, Objective-C, PHP, PL/SQL, Python, Swift, T-SQL, TypeScript, VB.Net
    • Irrelevant for Languages:
      HTML, XML
    • Remediation Function:
      Constant/Issue
    • Constant Cost:
      5min
    • Analysis Level:
      Control-flow Analysis
    • Analysis Scope:
      Main Sources, Test Sources
    • Common Rule:
      Yes
    • ESLint-SonarJS:
      no-one-iteration-loop
    • PMD:
      AvoidBranchingStatementAsLastInLoop
    • PVS-Studio:
      V612
    • TSLint-SonarTS:
      no-unconditional-jump
    • VisualStudio:
      CS0162

      Description

      A loop with at most one iteration is equivalent to the use of an if statement to conditionally execute one piece of code. No developer expects to find such a use of a loop statement. If the initial intention of the author was really to conditionally execute one piece of code, an if statement should be used instead.

      At worst that was not the initial intention of the author and so the body of the loop should be fixed to use the nested return, break or throw statements in a more appropriate way.

      Noncompliant Code Example

      for (int i = 0; i < 10; i++) { // noncompliant, loop only executes once
  printf("i is %d", i);
  break;
}
...
for (int i = 0; i < 10; i++) { // noncompliant, loop only executes once
  if (i == x) {
    break;
  } else {
    printf("i is %d", i);
    return;
  }
}

      Compliant Solution

      for (int i = 0; i < 10; i++) {
  printf("i is %d", i);
}
...
for (int i = 0; i < 10; i++) {
  if (i == x) {
    break;
  } else {
    printf("i is %d", i);
  }
}

        Attachments

          Issue Links

          is duplicated by

          Bug Detection - RSPEC-3554 Loop stop conditions should allow more than one iteration

          • Closed
          is implemented by

          Sub-task - The sub-task of the issue SONARPY-809 S1751: Add a message on the secondary location

          • Major - Major loss of function.
          • Open

          New Feature - A new feature of the product, which has yet to be developed. SONARCOBOL-1418 Rule S1751: Loops with at most one iteration should be refactored

          • Major - Major loss of function.
          • Open

          New Feature - A new feature of the product, which has yet to be developed. SONARFLEX-119 Rule: Loops with at most one iteration should be refactored

          • Major - Major loss of function.
          • Open

          New Feature - A new feature of the product, which has yet to be developed. SONARPLI-176 Rule: Loops with at most one iteration should be refactored

          • Major - Major loss of function.
          • Open

          New Feature - A new feature of the product, which has yet to be developed. SONARRPG-173 Rule: Loops with at most one iteration should be refactored

          • Major - Major loss of function.
          • Open

          New Feature - A new feature of the product, which has yet to be developed. SONARVBSIX-256 Rule: Loops with at most one iteration should be refactored

          • Major - Major loss of function.
          • Open

          New Feature - A new feature of the product, which has yet to be developed. CPP-617 Rule: Jump statements should not be used unconditionally

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARABAP-312 Rule: Jump statements should not be used unconditionally

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARJAVA-512 Rule S1751: Jump statements should not be used unconditionally

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARJS-822 Rule "Jump statements should not be used unconditionally"

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARPHP-666 Rule S1751: Loops with at most one iteration should be refactored

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARPLSQL-610 Rule: Jump statements should not be used unconditionally

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARPY-207 Rule: Loops with at most one iteration should be refactored

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARPY-442 Rule S1751: Loops with at most one iteration should be refactored

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARTSQL-110 Rule: Loops with at most one iteration should be refactored

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARVB-198 Rule S1751: Jump statements should not be used unconditionally

          • Major - Major loss of function.
          • Closed

          Task - A task that needs to be done. CPP-707 Create Objective-C rules repository containing targeted rules

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. SONARPLSQL-754 S1751: Add a message on the secondary location

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. SONARSWIFT-114 Rule: Jump statements should not be used unconditionally

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. SONARSWIFT-480 S1751: Add a message on the secondary location

          • Major - Major loss of function.
          • Closed
          is related to

          Improvement - An improvement or enhancement to an existing feature or task. CPP-2797 S1751, S1763: deduplicate, prefer specific S1751 over generic S1763

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. SONARABAP-364 Adjust S1751: exclude redundant jumps

          • Major - Major loss of function.
          • Closed

          MMF - Minimum Marketable Feature MMF-764 Java: Rules from FindBugs & PMD

          • Major - Major loss of function.
          • Closed

          Bug Detection - RSPEC-1763 All code should be reachable

          • Active
          relates to

          False-Positive - Unexpected issue reported by a rule SONARPHP-855 FP S1751 : for loop without update

          • Major - Major loss of function.
          • Closed

          Code Smell Detection - RSPEC-3626 Jump statements should not be redundant

          • Active
          links to

          Web Link is implemented by sonar-go/issues/62

          Web Link Is Implemented in SonarC# by #214

          Web Link Is Implemented in SonarTS by #8

          1.
          		 Swift RSPEC-2940 Language-Specification Active Unassigned
          2.
          		 JavaScript RSPEC-3813 Language-Specification Active Unassigned
          3.
          		 C# RSPEC-3980 Language-Specification Active Unassigned
          4.
          		 VB.Net RSPEC-4247 Language-Specification Active Unassigned
          5.
          		 ABAP RSPEC-4250 Language-Specification Active Unassigned
          6.
          		 PL/SQL RSPEC-4254 Language-Specification Active Unassigned
          7.
          		 T-SQL RSPEC-4506 Language-Specification Active Unassigned
          8.
          		 Go RSPEC-4611 Language-Specification Active Unassigned
          9.
          		 PHP RSPEC-4952 Language-Specification Active Unassigned
          10.
          		 Python RSPEC-5480 Language-Specification Active Unassigned
          11.
          		 C-Family RSPEC-5518 Language-Specification Active Unassigned

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                ann.campbell.2 Ann Campbell
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated: