#!/usr/bin/env python3

#  This file is part of Elixir, a source code cross-referencer.
#
#  Copyright (C) 2020 Carmeli Tamir and contributors
#
#  Elixir is free software: you can redistribute it and/or modify
#  it under the terms of the GNU Affero General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  Elixir is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU Affero General Public License for more details.
#
#  You should have received a copy of the GNU Affero General Public License
#  along with Elixir.  If not, see <http://www.gnu.org/licenses/>.

import os
import sys

import falcon
from falcon import testing

api_dir = os.path.abspath(os.path.join(os.path.dirname(os.path.realpath(__file__)), '..','api'))
sys.path.insert(0, api_dir)

from api import create_ident_getter

class APITest(testing.TestCase):
    def setUp(self):
        super(APITest, self).setUp()

        self.app = create_ident_getter()

    def test_identifier_not_found(self):
        result = self.simulate_get('/ident/testproj/SOME_NONEXISTENT_IDENTIFIER', query_string="version=latest&family=C")

        self.assertEqual(result.status_code, 200)
        self.assertEqual(result.json, {'definitions': [], 'references':[], 'documentations': []})

    def test_missing_version(self):
        # A get request without a version query string
        result = self.simulate_get('/ident/testproj/of_i2c_get_board_info', query_string="")

        self.assertEqual(result.status_code, 400)

        required_response = falcon.HTTPMissingParam('version')
        self.assertEqual(result.json["title"], required_response.title)
        self.assertEqual(result.json["description"], required_response.description)

    def test_existing_identifier(self):
        result_for_specific_version = self.simulate_get('/ident/testproj/of_i2c_get_board_info', query_string="version=v5.4&family=C")
        result_for_latest_version = self.simulate_get('/ident/testproj/of_i2c_get_board_info', query_string="version=latest&family=C")

        expected_json = {
            'definitions':
            [
                {'path': 'include/linux/i2c.h', 'line': 941, 'type': 'prototype'},
                {'path': 'drivers/i2c/i2c-core-of.c', 'line': 22, 'type': 'function'},
                {'path': 'include/linux/i2c.h', 'line': 968, 'type': 'function'}
            ],
            'references':
                [
                    {'path': 'drivers/i2c/i2c-core-of.c', 'line': '62,73', 'type': None}
                ],
                'documentations': []
            }

        self.assertEqual(result_for_specific_version.status_code, 200)
        self.assertEqual(result_for_latest_version.status_code, 200)

        self.assertEqual(result_for_specific_version.json, expected_json)
        self.assertEqual(result_for_latest_version.json, expected_json)