tests.custom.test_saucenao_limit

Complexity

Total Complexity

16

Size/Duplication

Total Lines	172
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	TestSauceNaoLimits.check_response_no_api_key()	0	13	2
A	TestSauceNaoLimits.tearDown()	0	6	1
A	TestSauceNaoLimits.setUp()	0	21	1
A	TestSauceNaoLimits.check_response_api_key()	0	14	2
A	TestSauceNaoLimits.run_tests()	0	14	3
B	TestSauceNaoLimits.test_limits()	0	43	6

#!/usr/bin/python

This module should have a docstring.

# -*- coding: utf-8 -*-
import logging
import os
import unittest
import uuid

import dotenv

Unable to import 'dotenv'

from PIL import Image

Unable to import 'PIL'

from saucenao.saucenao import DailyLimitReachedException
from saucenao.saucenao import SauceNao

dotenv_path = os.path.join(os.path.dirname(__file__), os.pardir, os.pardir, '.env')

This line is too long as per the coding-style (83/80).

The name dotenv_path does not conform to the constant naming conventions ((([A-Z_][A-Z0-9_]*)|(__.*__))$).

dotenv.load_dotenv(dotenv_path)

SAUCENAO_MIN_WIDTH = 3
SAUCENAO_MIN_HEIGHT = 3

SAUCENAO_IP_LIMIT_UNREGISTERED_USER = 150
SAUCENAO_IP_LIMIT_BASIC_USER = 300

SAUCENAO_API_KEY = os.environ.get('SAUCENAO_API_KEY')


def generate_small_jpg():
    """Generate a rather small jpg file to upload faster(631 bytes)

Found indentation with spaces instead of tabs

    :return:
    """
    file_path = str(uuid.uuid4()) + ".jpg"

Found indentation with spaces instead of tabs

    im = Image.new("RGB", (SAUCENAO_MIN_WIDTH, SAUCENAO_MIN_HEIGHT))

Found indentation with spaces instead of tabs

The name im does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

    im.save(os.path.join(os.getcwd(), file_path), "JPEG")

Found indentation with spaces instead of tabs

    return file_path

Found indentation with spaces instead of tabs

class TestSauceNaoLimits(unittest.TestCase):

The variable __class__ seems to be unused.

    """

Found indentation with spaces instead of tabs

    test cases to check the limits for SauceNAO

    currently not covered is the test case: account limit reached, ip limit not reached

This line is too long as per the coding-style (87/80).

    have to add a proxy for this test case to be covered.

    Test cases covered:
     - HTML response type: ip/account limit not reached
     - JSON response type: ip/account limit not reached
     - HTML response type: ip limit reached
     - JSON response type: ip limit reached
    """

    def setUp(self):

Found indentation with spaces instead of tabs

        """Constructor for the unittest

Found indentation with spaces instead of tabs

        :return:
        """
        self.test_jpg = generate_small_jpg()

Found indentation with spaces instead of tabs

        self.saucenao_html = SauceNao(os.getcwd(), output_type=SauceNao.API_HTML_TYPE, log_level=logging.DEBUG)

This line is too long as per the coding-style (111/80).

Found indentation with spaces instead of tabs

        self.saucenao_json = SauceNao(os.getcwd(), output_type=SauceNao.API_JSON_TYPE, log_level=logging.DEBUG)

This line is too long as per the coding-style (111/80).

Found indentation with spaces instead of tabs

        self.NOT_IP_LIMIT_NOT_ACCOUNT_LIMIT = [

Found indentation with spaces instead of tabs

The name NOT_IP_LIMIT_NOT_ACCOUNT_LIMIT does not conform to the attribute naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

            {'function': self.check_response_no_api_key, 'expected_success': True},

This line is too long as per the coding-style (83/80).

            {'function': self.check_response_api_key, 'expected_success': True}
        ]
        self.IP_LIMIT_NOT_ACCOUNT_LIMIT = [

Found indentation with spaces instead of tabs

The name IP_LIMIT_NOT_ACCOUNT_LIMIT does not conform to the attribute naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

            {'function': self.check_response_no_api_key, 'expected_success': False},

This line is too long as per the coding-style (84/80).

            {'function': self.check_response_api_key, 'expected_success': True}
        ]
        self.IP_LIMIT_ACCOUNT_LIMIT = [

Found indentation with spaces instead of tabs

The name IP_LIMIT_ACCOUNT_LIMIT does not conform to the attribute naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

            {'function': self.check_response_no_api_key, 'expected_success': False},

This line is too long as per the coding-style (84/80).

            {'function': self.check_response_api_key, 'expected_success': False}
        ]

    def tearDown(self):

Found indentation with spaces instead of tabs

        """Destructor for the unittest

Found indentation with spaces instead of tabs

        :return:
        """
        os.remove(self.test_jpg)

Found indentation with spaces instead of tabs

    def run_tests(self, saucenao: SauceNao, tests):

Found indentation with spaces instead of tabs

        """Run the different tests with the given SauceNao instance

Found indentation with spaces instead of tabs

        :type saucenao: SauceNao
        :type tests: list|tuple|Generator
        :return:
        """
        for test in tests:

Found indentation with spaces instead of tabs

            test_function = test['function']

Found indentation with spaces instead of tabs

            test_result = test['expected_success']

Found indentation with spaces instead of tabs

            try:

Found indentation with spaces instead of tabs

                test_function(saucenao, assert_success=test_result)

Found indentation with spaces instead of tabs

            except Exception as e:

Found indentation with spaces instead of tabs

Catching very general exceptions such as Exception is usually not recommended.

The name e does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

                self.fail("{} failed ({}: {})".format(test, type(e), e))

Found indentation with spaces instead of tabs

    def test_limits(self):

Found indentation with spaces instead of tabs

        """Test the limits of SauceNAO

Found indentation with spaces instead of tabs

        :return:
        """
        self.saucenao_html.logger.info('running HTML test, ip limit not reached, account limit not reached')

This line is too long as per the coding-style (108/80).

Found indentation with spaces instead of tabs

        self.run_tests(saucenao=self.saucenao_html, tests=self.NOT_IP_LIMIT_NOT_ACCOUNT_LIMIT)

This line is too long as per the coding-style (94/80).

Found indentation with spaces instead of tabs

        self.saucenao_html.logger.info('running JSON test, ip limit not reached, account limit not reached')

This line is too long as per the coding-style (108/80).

Found indentation with spaces instead of tabs

        self.run_tests(saucenao=self.saucenao_json, tests=self.NOT_IP_LIMIT_NOT_ACCOUNT_LIMIT)

This line is too long as per the coding-style (94/80).

Found indentation with spaces instead of tabs

        # now reach the daily limit without API key to reach the IP limit
        if self.saucenao_html._api_key:

Found indentation with spaces instead of tabs

It seems like _api_key was declared protected and should not be accessed from this context.

            self.saucenao_html._api_key = None

Found indentation with spaces instead of tabs

It seems like _api_key was declared protected and should not be accessed from this context.

        test_files = [self.test_jpg] * (SAUCENAO_IP_LIMIT_UNREGISTERED_USER - 2)

Found indentation with spaces instead of tabs

        try:

Found indentation with spaces instead of tabs

            # check_files returns a generator so we have to improvise here a bit
            for _ in self.saucenao_html.check_files(test_files):

Found indentation with spaces instead of tabs

Instance of 'SauceNao' has no 'check_files' member; maybe 'check_file'?

                pass

Found indentation with spaces instead of tabs

        except DailyLimitReachedException:

Found indentation with spaces instead of tabs

            pass

Found indentation with spaces instead of tabs

        # we are at 150 searches -> IP limit unregistered user reached, not basic user

This line is too long as per the coding-style (86/80).

        self.saucenao_html.logger.info('running HTML test, ip limit reached, account limit not reached')

This line is too long as per the coding-style (104/80).

Found indentation with spaces instead of tabs

        self.run_tests(saucenao=self.saucenao_html, tests=self.IP_LIMIT_NOT_ACCOUNT_LIMIT)

This line is too long as per the coding-style (90/80).

Found indentation with spaces instead of tabs

        self.saucenao_html.logger.info('running JSON test, ip limit reached, account limit not reached')

This line is too long as per the coding-style (104/80).

Found indentation with spaces instead of tabs

        self.run_tests(saucenao=self.saucenao_json, tests=self.IP_LIMIT_NOT_ACCOUNT_LIMIT)

This line is too long as per the coding-style (90/80).

Found indentation with spaces instead of tabs

        # set API key to reach the account limit
        self.saucenao_html._api_key = SAUCENAO_API_KEY

Found indentation with spaces instead of tabs

It seems like _api_key was declared protected and should not be accessed from this context.

        test_files = [self.test_jpg] * (SAUCENAO_IP_LIMIT_BASIC_USER - SAUCENAO_IP_LIMIT_UNREGISTERED_USER - 4)

This line is too long as per the coding-style (111/80).

Found indentation with spaces instead of tabs

        try:

Found indentation with spaces instead of tabs

            # check_files returns a generator so we have to improvise here a bit
            for _ in self.saucenao_html.check_files(test_files):

Found indentation with spaces instead of tabs

Instance of 'SauceNao' has no 'check_files' member; maybe 'check_file'?

                pass

Found indentation with spaces instead of tabs

        except DailyLimitReachedException:

Found indentation with spaces instead of tabs

            pass

Found indentation with spaces instead of tabs

        # we are at 30 searches -> IP limit basic user reached
        self.saucenao_html.logger.info('running HTML test, ip limit reached, account limit reached')

This line is too long as per the coding-style (100/80).

Found indentation with spaces instead of tabs

        self.run_tests(saucenao=self.saucenao_html, tests=self.IP_LIMIT_ACCOUNT_LIMIT)

This line is too long as per the coding-style (86/80).

Found indentation with spaces instead of tabs

        self.saucenao_html.logger.info('running JSON test, ip limit reached, account limit reached')

This line is too long as per the coding-style (100/80).

Found indentation with spaces instead of tabs

        self.run_tests(saucenao=self.saucenao_json, tests=self.IP_LIMIT_ACCOUNT_LIMIT)

This line is too long as per the coding-style (86/80).

Found indentation with spaces instead of tabs

    def check_response_no_api_key(self, saucenao: SauceNao, assert_success=True):

This line is too long as per the coding-style (81/80).

Found indentation with spaces instead of tabs

        """Check the response without an API key

Found indentation with spaces instead of tabs

        on assert_success=True expect a dictionary, else an exception

        :type saucenao: SauceNao
        :type assert_success: bool
        :return:
        """
        if assert_success:

Found indentation with spaces instead of tabs

            result = saucenao.check_file(self.test_jpg)

Found indentation with spaces instead of tabs

            self.assertIsInstance(result, list)

Found indentation with spaces instead of tabs

        else:

Found indentation with spaces instead of tabs

            self.assertRaises(DailyLimitReachedException, saucenao.check_file, self.test_jpg)

This line is too long as per the coding-style (93/80).

Found indentation with spaces instead of tabs

    def check_response_api_key(self, saucenao: SauceNao, assert_success=True):

Found indentation with spaces instead of tabs

        """Check the response with an API key

Found indentation with spaces instead of tabs

        on assert_success=True expect a dictionary, else an exception

        :type saucenao: SauceNao
        :type assert_success: bool
        :return:
        """
        saucenao._api_key = SAUCENAO_API_KEY

Found indentation with spaces instead of tabs

It seems like _api_key was declared protected and should not be accessed from this context.

        if assert_success:

Found indentation with spaces instead of tabs

            result = saucenao.check_file(self.test_jpg)

Found indentation with spaces instead of tabs

            self.assertIsInstance(result, list)

Found indentation with spaces instead of tabs

        else:

Found indentation with spaces instead of tabs

            self.assertRaises(DailyLimitReachedException, saucenao.check_file, self.test_jpg)

This line is too long as per the coding-style (93/80).

Found indentation with spaces instead of tabs

suite = unittest.TestLoader().loadTestsFromTestCase(TestSauceNaoLimits)

The name suite does not conform to the constant naming conventions ((([A-Z_][A-Z0-9_]*)|(__.*__))$).

unittest.TextTestRunner(verbosity=2).run(suite)