IBM-Swift/Kitura

View on GitHub
Tests/KituraTests/KituraTest.swift

Summary

Maintainability
D
2 days
Test Coverage

File KituraTest.swift has 299 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import XCTest
import Kitura

@testable import KituraNet

Severity: Minor
Found in Tests/KituraTests/KituraTest.swift - About 3 hrs to fix

    Function startUnixSocketServer has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

        private func startUnixSocketServer(router: ServerDelegate, options: ServerOptions?) -> String? {
            // Servers with options (live for duration of one test)
            if (options != nil) {
                let server = doStartUnixSocketServer(router: router, options: options)
                return server?.unixDomainSocketPath
    Severity: Minor
    Found in Tests/KituraTests/KituraTest.swift - 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

    Function performRequest has 33 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        func performRequest(_ method: String, path: String, port: Int? = nil, socketPath: String? = nil, useSSL: Bool? = nil, useUnixSocket: Bool? = nil, followRedirects: Bool = true,
                            callback: @escaping ClientRequest.Callback, headers: [String: String]? = nil,
                            requestModifier: ((ClientRequest) -> Void)? = nil) {
    
            let port = port ?? self.port
    Severity: Minor
    Found in Tests/KituraTests/KituraTest.swift - About 1 hr to fix

      Function startUnixSocketServer has 32 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private func startUnixSocketServer(router: ServerDelegate, options: ServerOptions?) -> String? {
              // Servers with options (live for duration of one test)
              if (options != nil) {
                  let server = doStartUnixSocketServer(router: router, options: options)
                  return server?.unixDomainSocketPath
      Severity: Minor
      Found in Tests/KituraTests/KituraTest.swift - About 1 hr to fix

        Function performRequest has 10 arguments (exceeds 4 allowed). Consider refactoring.
        Open

            func performRequest(_ method: String, path: String, port: Int? = nil, socketPath: String? = nil, useSSL: Bool? = nil, useUnixSocket: Bool? = nil, followRedirects: Bool = true,
                                callback: @escaping ClientRequest.Callback, headers: [String: String]? = nil,
                                requestModifier: ((ClientRequest) -> Void)? = nil) {
        Severity: Major
        Found in Tests/KituraTests/KituraTest.swift - About 1 hr to fix

          Function performServerTest has 29 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              func performServerTest(_ router: ServerDelegate, options: ServerOptions? = nil, sslOption: SSLOption = SSLOption.both, socketTypeOption: SocketTypeOption = SocketTypeOption.both, timeout: TimeInterval = 10,
                                     line: Int = #line, asyncTasks: [(XCTestExpectation) -> Void]) {
                  if sslOption != SSLOption.httpsOnly {
                      self.useSSL = false
                      if socketTypeOption != SocketTypeOption.unix {
          Severity: Minor
          Found in Tests/KituraTests/KituraTest.swift - About 1 hr to fix

            Function performServerTest has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
            Open

                func performServerTest(_ router: ServerDelegate, options: ServerOptions? = nil, sslOption: SSLOption = SSLOption.both, socketTypeOption: SocketTypeOption = SocketTypeOption.both, timeout: TimeInterval = 10,
                                       line: Int = #line, asyncTasks: [(XCTestExpectation) -> Void]) {
                    if sslOption != SSLOption.httpsOnly {
                        self.useSSL = false
                        if socketTypeOption != SocketTypeOption.unix {
            Severity: Minor
            Found in Tests/KituraTests/KituraTest.swift - 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

            Function performRequest has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
            Open

                func performRequest(_ method: String, path: String, port: Int? = nil, socketPath: String? = nil, useSSL: Bool? = nil, useUnixSocket: Bool? = nil, followRedirects: Bool = true,
                                    callback: @escaping ClientRequest.Callback, headers: [String: String]? = nil,
                                    requestModifier: ((ClientRequest) -> Void)? = nil) {
            
                    let port = port ?? self.port
            Severity: Minor
            Found in Tests/KituraTests/KituraTest.swift - 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

            Function startServer has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
            Open

                private func startServer(router: ServerDelegate, options: ServerOptions?) -> Int? {
                    // Servers with options (live for duration of one test)
                    if options != nil {
                        let server = doStartServer(router: router, options: options)
                        return server?.port
            Severity: Minor
            Found in Tests/KituraTests/KituraTest.swift - About 55 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

            Function performServerTest has 7 arguments (exceeds 4 allowed). Consider refactoring.
            Open

                func performServerTest(_ router: ServerDelegate, options: ServerOptions? = nil, sslOption: SSLOption = SSLOption.both, socketTypeOption: SocketTypeOption = SocketTypeOption.both, timeout: TimeInterval = 10,
                                       line: Int = #line, asyncTasks: (XCTestExpectation) -> Void...) {
            Severity: Major
            Found in Tests/KituraTests/KituraTest.swift - About 50 mins to fix

              Function performServerTest has 7 arguments (exceeds 4 allowed). Consider refactoring.
              Open

                  func performServerTest(_ router: ServerDelegate, options: ServerOptions? = nil, sslOption: SSLOption = SSLOption.both, socketTypeOption: SocketTypeOption = SocketTypeOption.both, timeout: TimeInterval = 10,
                                         line: Int = #line, asyncTasks: [(XCTestExpectation) -> Void]) {
              Severity: Major
              Found in Tests/KituraTests/KituraTest.swift - About 50 mins to fix

                Function doPerformServerTest has 5 arguments (exceeds 4 allowed). Consider refactoring.
                Open

                    func doPerformServerTest(router: ServerDelegate, options: ServerOptions?, timeout: TimeInterval, line: Int, asyncTasks: [(XCTestExpectation) -> Void]) {
                Severity: Minor
                Found in Tests/KituraTests/KituraTest.swift - About 35 mins to fix

                  Function buildServerTest has 5 arguments (exceeds 4 allowed). Consider refactoring.
                  Open

                      func buildServerTest(_ router: ServerDelegate, sslOption: SSLOption = SSLOption.both, socketTypeOption: SocketTypeOption = SocketTypeOption.both, timeout: TimeInterval = 10,
                                             line: Int = #line) -> RequestTestBuilder {
                  Severity: Minor
                  Found in Tests/KituraTests/KituraTest.swift - About 35 mins to fix

                    Function doPerformServerTest has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                    Open

                        func doPerformServerTest(router: ServerDelegate, options: ServerOptions?, timeout: TimeInterval, line: Int, asyncTasks: [(XCTestExpectation) -> Void]) {
                    
                            if self.useUnixSocket {
                                guard let socketPath = startUnixSocketServer(router: router, options: options) else {
                                    return XCTFail("Error starting server. useSSL:\(self.useSSL), useUnixSocket:\(self.useUnixSocket)")
                    Severity: Minor
                    Found in Tests/KituraTests/KituraTest.swift - About 35 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

                    Avoid too many return statements within this function.
                    Open

                            return server?.unixDomainSocketPath
                    Severity: Major
                    Found in Tests/KituraTests/KituraTest.swift - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                                      return server.unixDomainSocketPath
                      Severity: Major
                      Found in Tests/KituraTests/KituraTest.swift - About 30 mins to fix

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

                                if sslOption != SSLOption.httpsOnly {
                                    self.useSSL = false
                                    if socketTypeOption != SocketTypeOption.unix {
                                        self.useUnixSocket = false
                                        doPerformServerTest(router: router, options: options, timeout: timeout, line: line, asyncTasks: asyncTasks)
                        Severity: Major
                        Found in Tests/KituraTests/KituraTest.swift and 1 other location - About 1 hr to fix
                        Tests/KituraTests/KituraTest.swift on lines 137..150

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

                        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

                                if sslOption != SSLOption.httpOnly {
                                    self.useSSL = true
                                    if socketTypeOption != SocketTypeOption.unix {
                                        self.useUnixSocket = false
                                        doPerformServerTest(router: router, options: options, timeout: timeout, line: line, asyncTasks: asyncTasks)
                        Severity: Major
                        Found in Tests/KituraTests/KituraTest.swift and 1 other location - About 1 hr to fix
                        Tests/KituraTests/KituraTest.swift on lines 119..132

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

                        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

                                if useSSL {
                                    if let server = KituraTest.httpsUnixServer {
                                        server.delegate = router
                                        guard let listenPath = server.unixDomainSocketPath else {
                                            XCTFail("Unix socket path missing")
                        Severity: Minor
                        Found in Tests/KituraTests/KituraTest.swift and 1 other location - About 45 mins to fix
                        Tests/KituraTests/KituraTest.swift on lines 287..297

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

                        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

                                } else {
                                    if let server = KituraTest.httpUnixServer {
                                        server.delegate = router
                                        guard let listenPath = server.unixDomainSocketPath else {
                                            XCTFail("Unix socket path missing")
                        Severity: Minor
                        Found in Tests/KituraTests/KituraTest.swift and 1 other location - About 45 mins to fix
                        Tests/KituraTests/KituraTest.swift on lines 277..287

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

                        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

                        Condition should not be enclosed within parentheses
                        Open

                                if (options != nil) {
                        Severity: Minor
                        Found in Tests/KituraTests/KituraTest.swift by tailor

                        redundant-parentheses

                        Control flow constructs (if, else if, switch, for, while, repeat-while, and guard statements), Exception handling constructs (throw, and do/catch statements), and Initializers (array, dictionary, initializer patterns) should not be enclosed in parentheses.

                        Additionally, method calls with no parameters and a trailing closure should not have empty parentheses following the method name.

                        Control flow constructs

                        • if, else if statement

                        Preferred

                        if SomeCondition {
                        
                        } else if SomeOtherCondition {
                        }

                        Not Preferred

                        if (SomeCondition) {
                        
                        } else if (SomeOtherCondition) {
                        }
                        • switch statement

                        Preferred

                        switch SomeData {
                            default:
                                break
                        }

                        Not Preferred

                        switch (SomeData) {
                            default:
                                break
                        }
                        • for loop

                        Preferred

                        for var i = 0; i < 10; i+=1 {
                        
                        }

                        Not Preferred

                        for (var i = 0; i < 10; i+=1) {
                        
                        }
                        • while loop

                        Preferred

                        while SomeCondition {
                        
                        }

                        Not Preferred

                        while (SomeCondition) {
                        
                        }
                        • repeat-while loop

                        Preferred

                        repeat {
                        
                        } while SomeCondition

                        Not Preferred

                        repeat {
                        
                        } while (SomeCondition)
                        • guard clause

                        Preferred

                        guard true else {   }

                        Not Preferred

                        guard (true) else {   }

                        Exception handling constructs

                        • do/catch statement

                        Preferred

                        do  {
                        
                        } catch SomeException {
                        
                        }

                        Not Preferred

                        do  {
                        
                        } catch (SomeException) {
                        
                        }
                        • throw statement

                        Preferred

                        throw SomeException

                        Not Preferred

                        throw (SomeException)

                        Initializers

                        • array items

                        Preferred

                        var shoppingList: [String] = ["Eggs", "Milk"]

                        Not Preferred

                        var shoppingList: [String] = [("Eggs"), ("Milk")]
                        • dictionary items

                        Preferred

                        var airports: [String: String] = ["YYZ": "Toronto Pearson", "DUB": "Dublin"]

                        Not Preferred

                        var airports: [String: String] = [("YYZ"): ("Toronto Pearson"), ("DUB"): ("Dublin")]
                        • initializer patterns

                        Preferred

                        var x: Int = 2
                        var y: String = "Sleekbyte"
                        var x = 2

                        Not Preferred

                        var x: Int = (2)
                        var y: String = ("Sleekbyte")
                        var x = (2)

                        Method calls

                        Preferred

                        items.map {
                          item in item.transform()
                        }

                        Not Preferred

                        items.map() {
                          item in item.transform()
                        }

                        There are no issues that match your filters.

                        Category
                        Status