so5/ssh-client-wrapper

View on GitHub

Showing 33 of 33 total issues

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

async function send (hostInfo, argSrc, dst, rsyncOpt, timeout) {
Severity: Minor
Found in lib/rsyncExec.js - About 35 mins to fix

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

    function sshLoginCallback (output, ptyProcess, pw, ph, logger = debugSendPty) {
    Severity: Minor
    Found in lib/fork.js - About 35 mins to fix

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

      async function sshExec (hostInfo, cmd, timeout, outputCallback) {
        debug("sshExec called");
        await connect(hostInfo);
        debug("exec", cmd, "on remote server");
        const args = getSshOption(hostInfo, false);
      Severity: Minor
      Found in lib/sshExec.js - 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 logAndReject("opt must be array of string");
      Severity: Major
      Found in lib/index.js - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

            return send(this.hostInfo, src, dst, opt, timeout);
        Severity: Major
        Found in lib/index.js - About 30 mins to fix

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

                if (typeof pw === "string") {
                  debug("use given password");
                  sendPty(ptyProcess, `${pw}\n`, logger, 23);
                  resolve();
                }
          Severity: Minor
          Found in lib/fork.js and 1 other location - About 30 mins to fix
          lib/fork.js on lines 39..43

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

          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

          Avoid too many return statements within this function.
          Open

                return logAndReject("opt must be array of string");
          Severity: Major
          Found in lib/index.js - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                return recv(this.hostInfo, src, dst, opt, timeout);
            Severity: Major
            Found in lib/index.js - About 30 mins to fix

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

                    if (typeof ph === "string") {
                      debug("use given passphrase");
                      sendPty(ptyProcess, `${ph}\n`, logger, 38);
                      resolve();
                    }
              Severity: Minor
              Found in lib/fork.js and 1 other location - About 30 mins to fix
              lib/fork.js on lines 21..25

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

              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

              Function send has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
              Open

                async send (src, dst, opt = [], timeout = 0) {
                  debug("send called", src, dst, opt);
              
                  if (!isArrayOfString(src)) {
                    return logAndReject("src must be array of string");
              Severity: Minor
              Found in lib/index.js - 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

              Function getControlPersistDir has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
              Open

              function getControlPersistDir (hostInfo) {
                for (const candidate of [hostInfo.ControlPersistDir, process.env.SSH_CONTROL_PERSIST_DIR]) {
                  if (typeof candidate === "string") {
                    const stat = fs.statSync(candidate, { throwIfNoEntry: false });
                    if (stat.isDirectory()) {
              Severity: Minor
              Found in lib/util.js - 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

              Function constructor has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
              Open

                constructor (hostInfo) {
                  debug("constructor called for", hostInfo.host);
                  debugVerbose("hostInfo=", hostInfo);
                  this.hostInfo = { ...hostInfo };
                  sanityCheck(this.hostInfo);
              Severity: Minor
              Found in lib/index.js - 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

              Function existsMaster has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
              Open

              async function existsMaster (hostInfo, argTimeout) {
                debugVerbose("existsMaster called");
                const args = getSshOption(hostInfo);
                args.push("-Ocheck");
              
              
              Severity: Minor
              Found in lib/sshExec.js - 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

              Severity
              Category
              Status
              Source
              Language