Sign upLogin

bilalshaikh42/OASTools

View on GitHub
Star

Showing 111 of 111 total issues

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

                            if '$ref' in spec['schema']['items']:
                                definition_name = self.get_definition_name_from_ref(spec['schema']
                                                                                    ['items']['$ref'])
                                return [self.definitions_example[definition_name]]
                            else:
Severity: Minor
Found in oastools/parse/parser.py and 1 other location - About 45 mins to fix
oastools/parse/parser.py on lines 426..432

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

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 validate_request has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

    def validate_request(self, path, action, body=None, query=None):
        """Check if the given request is valid.
           Validates the body and the query
           # Rules to validate the BODY:
           # Let's limit this to mime types that either contain 'text' or 'json'
Severity: Minor
Found in oastools/parse/parser.py - About 45 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 deeply nested control flow statements.
Open

                        if not self.validate_definition(definition_name, body):
                            msg = "The body did not validate against its definition"
                            return False, msg
        # Check required
        if not all(param in processed_params for param, spec in action_spec['parameters'].items()
Severity: Major
Found in oastools/parse/parser.py - About 45 mins to fix

Avoid deeply nested control flow statements.
Open

                        for i in param_value:  # Check type of all elements in array
                            if not self.check_type(i, action_spec['parameters'][param_name]['items']['type']):
                                return False
Severity: Major
Found in oastools/parse/parser.py - About 45 mins to fix

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

                if '$ref' in prop_spec['schema']['items']:
                    definition_name = self.get_definition_name_from_ref(
                        prop_spec['schema']['items']['$ref'])
                else:
                    definition_name = self.get_definition_name_from_ref(
Severity: Minor
Found in oastools/parse/parser.py and 1 other location - About 45 mins to fix
oastools/parse/parser.py on lines 967..974

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

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 get_dict_definition has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    def get_dict_definition(self, dict, get_list=False):
        """Get the definition name of the given dict.
        Args:
            dict: dict to test.
            get_list: if set to true, return a list of definition that match the body.
Severity: Minor
Found in oastools/parse/parser.py - 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 self._example_from_array_spec(prop_spec)
Severity: Major
Found in oastools/parse/parser.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

        return True
Severity: Major
Found in oastools/parse/parser.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

                return False
Severity: Major
Found in oastools/parse/parser.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

        return True
Severity: Major
Found in oastools/parse/parser.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

            return self.get_example_from_prop_spec(prop_spec['schema'])
Severity: Major
Found in oastools/parse/parser.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

            return False
Severity: Major
Found in oastools/parse/parser.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

        return True, ""
Severity: Major
Found in oastools/parse/parser.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

            return self._get_example_from_basic_type(prop_spec['type'][0])[0]
Severity: Major
Found in oastools/parse/parser.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

                return False, msg
Severity: Major
Found in oastools/parse/parser.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

        return True, ""
Severity: Major
Found in oastools/parse/parser.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

            return ''
Severity: Major
Found in oastools/parse/parser.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

        return self._get_example_from_basic_type(prop_spec['type'])[0]
Severity: Major
Found in oastools/parse/parser.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

            return [prop_example]
Severity: Major
Found in oastools/parse/parser.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

            return ['null', 'null']
Severity: Major
Found in oastools/parse/parser.py - About 30 mins to fix
Severity
Category
Status
Source
Language