#  ___________________________________________________________________________
#
#  Pyomo: Python Optimization Modeling Objects
#  Copyright 2017 National Technology and Engineering Solutions of Sandia, LLC
#  Under the terms of Contract DE-NA0003525 with National Technology and 
#  Engineering Solutions of Sandia, LLC, the U.S. Government retains certain 
#  rights in this software.
#  This software is distributed under the 3-clause BSD License.
#  ___________________________________________________________________________

# Provide some test for rapper
# Author: David L. Woodruff (Sept 2018)

import pyutilib.th as unittest
import sys
import os
from pyomo.environ import SolverFactory, TerminationCondition
import pyomo.pysp.util.rapper as rapper
import pyomo as pyomoroot

__author__ = 'David L. Woodruff <DLWoodruff@UCDavis.edu>'
__version__ = 1.5

solvername = "ipopt" # could use almost any solver
solver_available =  SolverFactory(solvername).available(False)

class Test_abstract_rapper(unittest.TestCase):
    """ Test the rapper code."""

    def setUp(self):
        """ Get ready for tests"""

        p = str(pyomoroot.__path__)
        l = p.find("'")
        r = p.find("'", l+1)
        pyomorootpath = p[l+1:r]
        farmpath = pyomorootpath + os.sep + ".." + os.sep + "examples" + \
                   os.sep + "pysp" + os.sep + "farmer"
        farmpath = os.path.abspath(farmpath)
        
        # for AbstractModels
        self.farmer_ReferencePath = farmpath + os.sep + \
                                    "models" + os.sep + "ReferenceModel.py"
        self.farmer_scenarioPath = farmpath + os.sep + \
                                    "scenariodata"
        
    def tearDown(self):
        # from GH: This step is key, as Python keys off the name of the module, not the location.
        #       So, different reference models in different directories won't be detected.
        #       If you don't do this, the symptom is a model that doesn't have the attributes
        #       that the data file expects.
        if "ReferenceModel" in sys.modules:
            del sys.modules["ReferenceModel"]



    def test_Abstract_Construction(self):
        """ see if we can create the solver object for an AbstractModel"""
             
        stsolver = rapper.StochSolver(self.farmer_ReferencePath,
                                      fsfct = None,
                                      tree_model = self.farmer_scenarioPath,
                                      phopts = None)

    @unittest.skipIf(not solver_available,
                     "%s solver is not available" % (solvername,))
    def test_Abstract_ef(self):
        """ see if we can create the solver object for an AbstractModel"""
             
        stsolver = rapper.StochSolver(self.farmer_ReferencePath,
                                      fsfct = None,
                                      tree_model = self.farmer_scenarioPath,
                                      phopts = None)
        ef_sol = stsolver.solve_ef(solvername)
        assert(ef_sol.solver.termination_condition \
               ==  TerminationCondition.optimal)

# see also foo.py        
if __name__ == '__main__':
    unittest.main()