# EnergyPlus, Copyright (c) 1996-2023, The Board of Trustees of the University
# of Illinois, The Regents of the University of California, through Lawrence
# Berkeley National Laboratory (subject to receipt of any required approvals
# from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-
# Battelle, Alliance for Sustainable Energy, LLC, and other contributors. All
# rights reserved.
#
# NOTICE: This Software was developed under funding from the U.S. Department of
# Energy and the U.S. Government consequently retains certain rights. As such,
# the U.S. Government has been granted for itself and others acting on its
# behalf a paid-up, nonexclusive, irrevocable, worldwide license in the
# Software to reproduce, distribute copies to the public, prepare derivative
# works, and perform publicly and display publicly, and to permit others to do
# so.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# (1) Redistributions of source code must retain the above copyright notice,
#     this list of conditions and the following disclaimer.
#
# (2) Redistributions in binary form must reproduce the above copyright notice,
#     this list of conditions and the following disclaimer in the documentation
#     and/or other materials provided with the distribution.
#
# (3) Neither the name of the University of California, Lawrence Berkeley
#     National Laboratory, the University of Illinois, U.S. Dept. of Energy nor
#     the names of its contributors may be used to endorse or promote products
#     derived from this software without specific prior written permission.
#
# (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in
#     stand-alone form without changes from the version obtained under this
#     License, or (ii) Licensee makes a reference solely to the software
#     portion of its product, Licensee must refer to the software as
#     "EnergyPlus version X" software, where "X" is the version number Licensee
#     obtained under this License and may not use a different name for the
#     software. Except as specifically required in this Section (4), Licensee
#     shall not use in a company name, a product name, in advertising,
#     publicity, or other promotional activities any name, trade name,
#     trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or
#     confusingly similar designation, without the U.S. Department of Energy's
#     prior written consent.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

import idd_parser
import pytest


# If this timeouts while you make modifications, you can do `pip install pytest-timeout` and use this mark here:
# @pytest.mark.timeout(2)
def test_ok_idd():
    data = idd_parser.Data()
    data.file = r"""
! Comment

\group test

OkObject,
  A1; \field Name
      \minimum 1

NotBrokenObject,
  A1, \field Name
  N2; \field Last Field
      \maximum 10

Obj2,
  A1; \field Name
"""
    idd_parser.parse_idd(data)
    assert data.schema["properties"].keys() == {"OkObject", "NotBrokenObject", "Obj2"}
    assert data.schema["properties"]["NotBrokenObject"] == {
        "patternProperties": {
            ".*": {"type": "object", "properties": {"last_field": {"type": "number", "maximum": 10.0}}}
        },
        "group": "test",
        "name": {"type": "string"},
        "legacy_idd": {
            "field_info": {
                "name": {"field_name": "Name", "field_type": "a"},
                "last_field": {"field_name": "Last Field", "field_type": "n"},
            },
            "fields": ["name", "last_field"],
            "alphas": {"fields": ["name"]},
            "numerics": {"fields": ["last_field"]},
        },
        "type": "object",
    }


def test_broken_idd():
    data = idd_parser.Data()
    data.file = r"""! Comment

\group test

OkObject,
  A1; \field Name
      \minimum 1

BrokenObject,
  A1, \field Name
  A2, \field Last Field
      \maximum 10

Obj2,
  A1; \field Name
"""
    with pytest.raises(idd_parser.MissingSemiColonException) as e:
        idd_parser.parse_idd(data)

    assert (
        str(e.value)
        == r"""In object 'BrokenObject', Missing semi-colon in field A2
Context:
  A1; \field Name
      \minimum 1

BrokenObject,
  A1, \field Name
  A2, \field Last Field
    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      \maximum 10

Obj2,
  A1; \field Name"""
    )


def test_broken_idd_2():
    data = idd_parser.Data()
    data.file = r"""BrokenObject,
  A1 \field Name
  A2, \field Other
"""
    with pytest.raises(idd_parser.IddParsingError) as e:
        idd_parser.parse_idd(data)
    assert (
        str(e.value)
        == r"""In object 'BrokenObject', No comma or semicolon after field A1
Context:
BrokenObject,
  A1 \field Name
    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  A2, \field Other"""
    )


def METHOD_NAME():
    data = idd_parser.Data()
    data.file = r"""BrokenObject,
      \obsolete
  A1; \field Name

"""
    with pytest.raises(idd_parser.IddParsingError) as e:
        idd_parser.parse_idd(data)
    assert (
        str(e.value)
        == r"""In object 'BrokenObject', expected string after /obsolete
Context:
BrokenObject,
      \obsolete
                ^~~~~~~~~~~~~~~~~~~~~~~~~
  A1; \field Name
"""
    )


def test_duplicate_a_field_number():
    data = idd_parser.Data()
    data.file = r"""BrokenObject,
  A1, \field Name
  N1, \field Number 1
  A1, \field String Field
  N2; \field Number 1
"""
    with pytest.raises(idd_parser.IddParsingError) as e:
        idd_parser.parse_idd(data)
    assert (
        str(e.value)
        == r"""In object 'BrokenObject', duplicate field number A1
Context:
BrokenObject,
  A1, \field Name
  N1, \field Number 1
  A1, \field String Field
     ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  N2; \field Number 1"""
    )


def test_duplicate_n_field_number():
    data = idd_parser.Data()
    data.file = r"""BrokenObject,
  A1, \field Name
  N1, \field Number 1
  A2, \field String Field
  N1; \field Number 1
"""
    with pytest.raises(idd_parser.IddParsingError) as e:
        idd_parser.parse_idd(data)
    assert (
        str(e.value)
        == r"""In object 'BrokenObject', duplicate field number N1
Context:
BrokenObject,
  A1, \field Name
  N1, \field Number 1
  A2, \field String Field
  N1; \field Number 1
     ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"""
    )