#
# BitBake Test for lib/bb/parse/
#
# Copyright (C) 2015 Richard Purdie
#
# SPDX-License-Identifier: GPL-2.0-only
#

import unittest
import tempfile
import logging
import bb
import os
import subprocess
import textwrap

logger = logging.getLogger('BitBake.TestParse')

import bb.parse
import bb.data
import bb.siggen

class ParseTest(unittest.TestCase):

    testfile = """
A = "1"
B = "2"
do_install() {
	echo "hello"
}

C = "3"
"""

    def setUp(self):
        self.origdir = os.getcwd()
        self.d = bb.data.init()
        bb.parse.siggen = bb.siggen.init(self.d)

    def tearDown(self):
        os.chdir(self.origdir)

    def parsehelper(self, content, suffix = ".bb"):
        f = tempfile.NamedTemporaryFile(suffix = suffix)
        f.write(bytes(content, "utf-8"))
        f.flush()
        os.chdir(os.path.dirname(f.name))
        return f

    def test_parse_simple(self):
        with self.parsehelper(self.testfile) as f:
            d = bb.parse.handle(f.name, self.d)['']
        self.assertEqual(d.getVar("A"), "1")
        self.assertEqual(d.getVar("B"), "2")
        self.assertEqual(d.getVar("C"), "3")

    def test_parse_incomplete_function(self):
        testfileB = self.testfile.replace("}", "")
        with self.parsehelper(testfileB) as f:
            with self.assertRaises(bb.parse.ParseError):
                d = bb.parse.handle(f.name, self.d)['']

    unsettest = """
A = "1"
B = "2"
B[flag] = "3"

unset A
unset B[flag]
"""

    def test_parse_unset(self):
        with self.parsehelper(self.unsettest) as f:
            d = bb.parse.handle(f.name, self.d)['']
        self.assertEqual(d.getVar("A"), None)
        self.assertEqual(d.getVarFlag("A","flag"), None)
        self.assertEqual(d.getVar("B"), "2")

    defaulttest = """
A = "set value"
A ??= "default value"

A[flag_set_vs_question] = "set flag"
A[flag_set_vs_question] ?= "question flag"

A[flag_set_vs_default] = "set flag"
A[flag_set_vs_default] ??= "default flag"

A[flag_question] ?= "question flag"

A[flag_default] ??= "default flag"

A[flag_question_vs_default] ?= "question flag"
A[flag_question_vs_default] ??= "default flag"

A[flag_default_vs_question] ??= "default flag"
A[flag_default_vs_question] ?= "question flag"

A[flag_set_question_default] = "set flag"
A[flag_set_question_default] ?= "question flag"
A[flag_set_question_default] ??= "default flag"

A[flag_set_default_question] = "set flag"
A[flag_set_default_question] ??= "default flag"
A[flag_set_default_question] ?= "question flag"

A[flag_set_twice] = "set flag first"
A[flag_set_twice] = "set flag second"

A[flag_question_twice] ?= "question flag first"
A[flag_question_twice] ?= "question flag second"

A[flag_default_twice] ??= "default flag first"
A[flag_default_twice] ??= "default flag second"
"""
    def test_parse_defaulttest(self):
        with self.parsehelper(self.defaulttest) as f:
            d = bb.parse.handle(f.name, self.d)['']
        self.assertEqual(d.getVar("A"), "set value")
        self.assertEqual(d.getVarFlag("A","flag_set_vs_question"), "set flag")
        self.assertEqual(d.getVarFlag("A","flag_set_vs_default"), "set flag")
        self.assertEqual(d.getVarFlag("A","flag_question"), "question flag")
        self.assertEqual(d.getVarFlag("A","flag_default"), "default flag")
        self.assertEqual(d.getVarFlag("A","flag_question_vs_default"), "question flag")
        self.assertEqual(d.getVarFlag("A","flag_default_vs_question"), "question flag")
        self.assertEqual(d.getVarFlag("A","flag_set_question_default"), "set flag")
        self.assertEqual(d.getVarFlag("A","flag_set_default_question"), "set flag")
        self.assertEqual(d.getVarFlag("A","flag_set_twice"), "set flag second")
        self.assertEqual(d.getVarFlag("A","flag_question_twice"), "question flag first")
        self.assertEqual(d.getVarFlag("A","flag_default_twice"), "default flag second")

    exporttest = """
A = "a"
export B = "b"
export C
exportD = "d"
"""

    def test_parse_exports(self):
        with self.parsehelper(self.exporttest) as f:
            d = bb.parse.handle(f.name, self.d)['']
        self.assertEqual(d.getVar("A"), "a")
        self.assertIsNone(d.getVarFlag("A", "export"))
        self.assertEqual(d.getVar("B"), "b")
        self.assertEqual(d.getVarFlag("B", "export"), 1)
        self.assertIsNone(d.getVar("C"))
        self.assertEqual(d.getVarFlag("C", "export"), 1)
        self.assertIsNone(d.getVar("D"))
        self.assertIsNone(d.getVarFlag("D", "export"))
        self.assertEqual(d.getVar("exportD"), "d")
        self.assertIsNone(d.getVarFlag("exportD", "export"))

    overridetest = """
RRECOMMENDS:${PN} = "a"
RRECOMMENDS:${PN}:libc = "b"
OVERRIDES = "libc:${PN}"
PN = "gtk+"
"""

    def test_parse_overrides(self):
        with self.parsehelper(self.overridetest) as f:
            d = bb.parse.handle(f.name, self.d)['']
        self.assertEqual(d.getVar("RRECOMMENDS"), "b")
        bb.data.expandKeys(d)
        self.assertEqual(d.getVar("RRECOMMENDS"), "b")
        d.setVar("RRECOMMENDS:gtk+", "c")
        self.assertEqual(d.getVar("RRECOMMENDS"), "c")

    overridetest2 = """
EXTRA_OECONF = ""
EXTRA_OECONF:class-target = "b"
EXTRA_OECONF:append = " c"
"""

    def test_parse_overrides2(self):
        with self.parsehelper(self.overridetest2) as f:
            d = bb.parse.handle(f.name, self.d)['']
        d.appendVar("EXTRA_OECONF", " d")
        d.setVar("OVERRIDES", "class-target")
        self.assertEqual(d.getVar("EXTRA_OECONF"), "b c d")

    overridetest3 = """
DESCRIPTION = "A"
DESCRIPTION:${PN}-dev = "${DESCRIPTION} B"
PN = "bc"
"""

    def test_parse_combinations(self):
        with self.parsehelper(self.overridetest3) as f:
            d = bb.parse.handle(f.name, self.d)['']
        bb.data.expandKeys(d)
        self.assertEqual(d.getVar("DESCRIPTION:bc-dev"), "A B")
        d.setVar("DESCRIPTION", "E")
        d.setVar("DESCRIPTION:bc-dev", "C D")
        d.setVar("OVERRIDES", "bc-dev")
        self.assertEqual(d.getVar("DESCRIPTION"), "C D")

    classextend = """
VAR_var:override1 = "B"
EXTRA = ":override1"
OVERRIDES = "nothing${EXTRA}"

BBCLASSEXTEND = "###CLASS###"
"""
    classextend_bbclass = """
EXTRA = ""
python () {
    d.renameVar("VAR_var", "VAR_var2")
}
"""

    #
    # Test based upon a real world data corruption issue. One
    # data store changing a variable poked through into a different data
    # store. This test case replicates that issue where the value 'B' would
    # become unset/disappear.
    #
    def test_parse_classextend_contamination(self):
        self.d.setVar("__bbclasstype", "recipe")
        with self.parsehelper(self.classextend_bbclass, suffix=".bbclass") as cls:
            #clsname = os.path.basename(cls.name).replace(".bbclass", "")
            self.classextend = self.classextend.replace("###CLASS###", cls.name)
            with self.parsehelper(self.classextend) as f:
                alldata = bb.parse.handle(f.name, self.d)
            d1 = alldata['']
            d2 = alldata[cls.name]
            self.assertEqual(d1.getVar("VAR_var"), "B")
            self.assertEqual(d2.getVar("VAR_var"), None)

    addtask_deltask = """
addtask do_patch after do_foo after do_unpack before do_configure before do_compile
addtask do_fetch2 do_patch2

addtask do_myplaintask
addtask do_myplaintask2
deltask do_myplaintask2
addtask do_mytask# comment
addtask do_mytask2 # comment2
addtask do_mytask3
deltask do_mytask3# comment
deltask do_mytask4 # comment2

# Ensure a missing task prefix on after works
addtask do_mytask5 after mytask

MYVAR = "do_patch"
EMPTYVAR = ""
deltask do_fetch ${MYVAR} ${EMPTYVAR}
deltask ${EMPTYVAR}
"""
    def test_parse_addtask_deltask(self):
        with self.parsehelper(self.addtask_deltask) as f:
            d = bb.parse.handle(f.name, self.d)['']
        self.assertSequenceEqual(['do_fetch2', 'do_patch2', 'do_myplaintask', 'do_mytask', 'do_mytask2', 'do_mytask5'], bb.build.listtasks(d))
        self.assertEqual(['do_mytask'], d.getVarFlag("do_mytask5", "deps"))

    broken_multiline_comment = """
# First line of comment \\
# Second line of comment \\

"""
    def test_parse_broken_multiline_comment(self):
        with self.parsehelper(self.broken_multiline_comment) as f:
            with self.assertRaises(bb.BBHandledException):
                d = bb.parse.handle(f.name, self.d)['']

    comment_in_var = """
VAR = " \\
    SOMEVAL \\
#   some comment \\
    SOMEOTHERVAL \\
"
"""
    def test_parse_comment_in_var(self):
        with self.parsehelper(self.comment_in_var) as f:
            with self.assertRaises(bb.BBHandledException):
                d = bb.parse.handle(f.name, self.d)['']

    at_sign_in_var_flag = """
A[flag@.service] = "nonet"
B[flag@.target] = "ntb"
C[f] = "flag"

unset A[flag@.service]
"""
    def test_parse_at_sign_in_var_flag(self):
        with self.parsehelper(self.at_sign_in_var_flag) as f:
            d = bb.parse.handle(f.name, self.d)['']
        self.assertEqual(d.getVar("A"), None)
        self.assertEqual(d.getVar("B"), None)
        self.assertEqual(d.getVarFlag("A","flag@.service"), None)
        self.assertEqual(d.getVarFlag("B","flag@.target"), "ntb")
        self.assertEqual(d.getVarFlag("C","f"), "flag")

    def test_parse_invalid_at_sign_in_var_flag(self):
        invalid_at_sign = self.at_sign_in_var_flag.replace("B[f", "B[@f")
        with self.parsehelper(invalid_at_sign) as f:
            with self.assertRaises(bb.parse.ParseError):
                d = bb.parse.handle(f.name, self.d)['']

    export_function_recipe = """
inherit someclass
"""

    export_function_recipe2 = """
inherit someclass

do_compile () {
    false
}

python do_compilepython () {
    bb.note("Something else")
}

"""
    export_function_class = """
someclass_do_compile() {
    true
}

python someclass_do_compilepython () {
    bb.note("Something")
}

EXPORT_FUNCTIONS do_compile do_compilepython
"""

    export_function_class2 = """
secondclass_do_compile() {
    true
}

python secondclass_do_compilepython () {
    bb.note("Something")
}

EXPORT_FUNCTIONS do_compile do_compilepython
"""

    def test_parse_export_functions(self):
        def check_function_flags(d):
            self.assertEqual(d.getVarFlag("do_compile", "func"), 1)
            self.assertEqual(d.getVarFlag("do_compilepython", "func"), 1)
            self.assertEqual(d.getVarFlag("do_compile", "python"), None)
            self.assertEqual(d.getVarFlag("do_compilepython", "python"), "1")

        with tempfile.TemporaryDirectory() as tempdir:
            self.d.setVar("__bbclasstype", "recipe")
            recipename = tempdir + "/recipe.bb"
            os.makedirs(tempdir + "/classes")
            with open(tempdir + "/classes/someclass.bbclass", "w") as f:
                f.write(self.export_function_class)
            with open(tempdir + "/classes/secondclass.bbclass", "w") as f:
                f.write(self.export_function_class2)

            with open(recipename, "w") as f:
                f.write(self.export_function_recipe)
            os.chdir(tempdir)
            d = bb.parse.handle(recipename, bb.data.createCopy(self.d))['']
            self.assertIn("someclass_do_compile", d.getVar("do_compile"))
            self.assertIn("someclass_do_compilepython", d.getVar("do_compilepython"))
            check_function_flags(d)

            recipename2 = tempdir + "/recipe2.bb"
            with open(recipename2, "w") as f:
                f.write(self.export_function_recipe2)

            d = bb.parse.handle(recipename2, bb.data.createCopy(self.d))['']
            self.assertNotIn("someclass_do_compile", d.getVar("do_compile"))
            self.assertNotIn("someclass_do_compilepython", d.getVar("do_compilepython"))
            self.assertIn("false", d.getVar("do_compile"))
            self.assertIn("else", d.getVar("do_compilepython"))
            check_function_flags(d)

            with open(recipename, "a+") as f:
                f.write("\ninherit secondclass\n")
            with open(recipename2, "a+") as f:
                f.write("\ninherit secondclass\n")

            d = bb.parse.handle(recipename, bb.data.createCopy(self.d))['']
            self.assertIn("secondclass_do_compile", d.getVar("do_compile"))
            self.assertIn("secondclass_do_compilepython", d.getVar("do_compilepython"))
            check_function_flags(d)

            d = bb.parse.handle(recipename2, bb.data.createCopy(self.d))['']
            self.assertNotIn("someclass_do_compile", d.getVar("do_compile"))
            self.assertNotIn("someclass_do_compilepython", d.getVar("do_compilepython"))
            self.assertIn("false", d.getVar("do_compile"))
            self.assertIn("else", d.getVar("do_compilepython"))
            check_function_flags(d)

    export_function_unclosed_tab = """
do_compile () {
       bb.note("Something")
\t}
"""
    export_function_unclosed_space = """
do_compile () {
       bb.note("Something")
 }
"""
    export_function_residue = """
do_compile () {
       bb.note("Something")
}

include \\
"""

    def test_unclosed_functions(self):
        def test_helper(content, expected_error):
            with tempfile.TemporaryDirectory() as tempdir:
                recipename = tempdir + "/recipe_unclosed.bb"
                with open(recipename, "w") as f:
                    f.write(content)
                os.chdir(tempdir)
                with self.assertRaises(bb.parse.ParseError) as error:
                    bb.parse.handle(recipename, bb.data.createCopy(self.d))
                self.assertIn(expected_error, str(error.exception))

        with tempfile.TemporaryDirectory() as tempdir:
            test_helper(self.export_function_unclosed_tab, "Unparsed lines from unclosed function")
            test_helper(self.export_function_unclosed_space, "Unparsed lines from unclosed function")
            test_helper(self.export_function_residue, "Unparsed lines")

            recipename_closed = tempdir + "/recipe_closed.bb"
            with open(recipename_closed, "w") as in_file:
                lines = self.export_function_unclosed_tab.split("\n")
                lines[3] = "}"
                in_file.write("\n".join(lines))
            bb.parse.handle(recipename_closed, bb.data.createCopy(self.d))

    special_character_assignment = """
A+="a"
A+ = "b"
+ = "c"
"""
    ambigous_assignment = """
+= "d"
"""
    def test_parse_special_character_assignment(self):
        with self.parsehelper(self.special_character_assignment) as f:
            d = bb.parse.handle(f.name, self.d)['']
        self.assertEqual(d.getVar("A"), " a")
        self.assertEqual(d.getVar("A+"), "b")
        self.assertEqual(d.getVar("+"), "c")

        with self.parsehelper(self.ambigous_assignment) as f:
            with self.assertRaises(bb.parse.ParseError) as error:
                bb.parse.handle(f.name, self.d)
        self.assertIn("Empty variable name in assignment", str(error.exception))

    someconf1 = """
EXTRA_OECONF:append = " foo"
"""

    someconf2 = """
EXTRA_OECONF:append = " bar"
"""

    someconf3 = """
EXTRA_OECONF:append = " foobar"
"""

    def test_include_and_require(self):
        def test_helper(content, result):
            with self.parsehelper(content) as f:
                if isinstance(result, type) and issubclass(result, Exception):
                    with self.assertRaises(result):
                        d = bb.parse.handle(f.name, bb.data.createCopy(self.d))['']
                else:
                    d = bb.parse.handle(f.name, bb.data.createCopy(self.d))['']
                    self.assertEqual(d.getVar("EXTRA_OECONF"), result)

        with tempfile.TemporaryDirectory() as tempdir:
            os.makedirs(tempdir + "/conf1")
            os.makedirs(tempdir + "/conf2")

            with open(tempdir + "/conf1/some.conf", "w") as f:
                f.write(self.someconf1)
            with open(tempdir + "/conf2/some.conf", "w") as f:
                f.write(self.someconf2)
            with open(tempdir + "/conf2/some3.conf", "w") as f:
                f.write(self.someconf3)

            self.d.setVar("BBPATH", tempdir + "/conf1" + ":" + tempdir + "/conf2")

            test_helper("include some.conf", " foo")
            test_helper("include someother.conf", None)
            test_helper("include some3.conf", " foobar")
            test_helper("include ${@''}", None)
            test_helper("include " + tempdir + "/conf2/some.conf", " bar")

            test_helper("require some.conf", " foo")
            test_helper("require someother.conf", bb.parse.ParseError)
            test_helper("require some3.conf", " foobar")
            test_helper("require ${@''}", None)
            test_helper("require " + tempdir + "/conf2/some.conf", " bar")

            test_helper("include_all some.conf", " foo bar")
            test_helper("include_all someother.conf", None)
            test_helper("include_all some3.conf", " foobar")

            self.d.setVar("BBPATH", tempdir + "/conf2" + ":" + tempdir + "/conf1")

            test_helper("include some.conf", " bar")
            test_helper("include some3.conf", " foobar")
            test_helper("require some.conf", " bar")
            test_helper("require some3.conf", " foobar")
            test_helper("include_all some.conf", " bar foo")
            test_helper("include_all some3.conf", " foobar")

    def test_file_variables(self):
        # Tests the values of FILE and __BB_RECIPE_FILE in different
        # combinations of bbappends, includes, and inherits

        def write_file(path, data):
            with open(path, "w") as f:
                f.write(textwrap.dedent(data))

        def run_bitbake(cmd, builddir, extraenv={}):
            env = os.environ.copy()
            env["BBPATH"] = os.path.realpath(os.path.join(os.path.dirname(__file__), "parse-tests"))
            env["BB_ENV_PASSTHROUGH_ADDITIONS"] = "TOPDIR"
            env["TOPDIR"] = builddir
            for k, v in extraenv.items():
                env[k] = v
                env["BB_ENV_PASSTHROUGH_ADDITIONS"] = env["BB_ENV_PASSTHROUGH_ADDITIONS"] + " " + k
            try:
                return subprocess.check_output(cmd, env=env, stderr=subprocess.STDOUT, universal_newlines=True, cwd=builddir)
            except subprocess.CalledProcessError as e:
                self.fail("Command %s failed with %s" % (cmd, e.output))

        with tempfile.TemporaryDirectory(prefix="parserecipes") as recipes, tempfile.TemporaryDirectory(prefix="parsetest") as builddir:
            extraenv = {
                "EXTRA_BBFILES": f"{recipes}/*.bb {recipes}/*.bbappend",
            }

            inc_path = f"{recipes}/recipe-file.inc"
            bbappend_path = f"{recipes}/recipe-%.bbappend"
            recipe_path = f"{recipes}/recipe-file1.bb"

            # __BB_RECIPE_FILE should always be the name of .bb file, even
            # when set in a bbappend. FILE is the name of the bbappend
            write_file(recipe_path, "")
            write_file(bbappend_path,
                """\
                BBAPPEND_RECIPE_FILE := "${@os.path.basename(d.getVar('__BB_RECIPE_FILE'))}"
                BBAPPEND_FILE := "${@os.path.basename(d.getVar('FILE'))}"
                """
            )
            output = run_bitbake(["bitbake", "-e", "recipe-file1"], builddir, extraenv).splitlines()
            self.assertIn('BBAPPEND_FILE="recipe-%.bbappend"', output)
            self.assertIn(f'BBAPPEND_RECIPE_FILE="recipe-file1.bb"', output)

            # __BB_RECIPE_FILE should always be the name of .bb file, even when
            # set in an include file. FILE is the name of the include
            write_file(recipe_path,
                """\
                require recipe-file.inc
                """
            )
            write_file(inc_path,
                """\
                INC_RECIPE_FILE := "${@os.path.basename(d.getVar('__BB_RECIPE_FILE'))}"
                INC_FILE := "${@os.path.basename(d.getVar('FILE'))}"
                """
            )
            output = run_bitbake(["bitbake", "-e", "recipe-file1"], builddir, extraenv).splitlines()
            self.assertIn('INC_FILE="recipe-file.inc"', output)
            self.assertIn(f'INC_RECIPE_FILE="recipe-file1.bb"', output)

            # Test when the include file is included from a bbappend
            write_file(recipe_path, "")
            write_file(bbappend_path,
                """\
                require recipe-file.inc
                """
            )
            output = run_bitbake(["bitbake", "-e", "recipe-file1"], builddir, extraenv).splitlines()
            self.assertIn('INC_FILE="recipe-file.inc"', output)
            self.assertIn(f'INC_RECIPE_FILE="recipe-file1.bb"', output)

            # Test the variables in a bbclass when inherited directly in the
            # recipe. Note that FILE still refers to the recipe in a bbclass
            write_file(recipe_path,
                """\
                inherit recipe-file-class
                """
            )
            output = run_bitbake(["bitbake", "-e", "recipe-file1"], builddir, extraenv).splitlines()
            self.assertIn('BBCLASS_FILE="recipe-file1.bb"', output)
            self.assertIn(f'BBCLASS_RECIPE_FILE="recipe-file1.bb"', output)

            # Test the variables when the inherit is in a bbappend. In this
            # case, FILE is the bbappend
            write_file(recipe_path, "")
            write_file(bbappend_path,
                """\
                inherit recipe-file-class
                """
            )
            output = run_bitbake(["bitbake", "-e", "recipe-file1"], builddir, extraenv).splitlines()
            self.assertIn('BBCLASS_FILE="recipe-%.bbappend"', output)
            self.assertIn(f'BBCLASS_RECIPE_FILE="recipe-file1.bb"', output)

            # Test the variables when the inherit is in a include. In this
            # case, FILE is the include file
            write_file(recipe_path,
                """\
                require recipe-file.inc
                """
            )
            write_file(bbappend_path, "")
            write_file(inc_path,
                """\
                inherit recipe-file-class
                """
            )
            output = run_bitbake(["bitbake", "-e", "recipe-file1"], builddir, extraenv).splitlines()
            self.assertIn('BBCLASS_FILE="recipe-file.inc"', output)
            self.assertIn(f'BBCLASS_RECIPE_FILE="recipe-file1.bb"', output)

            # Test the variables when the inherit is in a include included from
            # a bbappend. In this case, FILE is the include file
            write_file(recipe_path, "")
            write_file(bbappend_path,
                """\
                require recipe-file.inc
                """
            )
            write_file(inc_path,
                """\
                inherit recipe-file-class
                """
            )
            output = run_bitbake(["bitbake", "-e", "recipe-file1"], builddir, extraenv).splitlines()
            self.assertIn('BBCLASS_FILE="recipe-file.inc"', output)
            self.assertIn(f'BBCLASS_RECIPE_FILE="recipe-file1.bb"', output)