##############################################################################
#
# Copyright (c) 2019 Nexedi SA and Contributors. All Rights Reserved.
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsibility of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# guarantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

import os

from slapos.testing.testcase import (
    makeModuleSetUpAndTestCaseClass,
    installSoftwareUrlList,
  )

parent_folder = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))

software_files =  ['software%s.cfg' % v for v in ('', '-py3next', '-py2')]

software_urls = [os.path.join(parent_folder, name) for name in software_files]

_, SlapOSInstanceTestCase = makeModuleSetUpAndTestCaseClass(
  parent_folder + '/{' + '|'.join(software_files) + '}' # used only for display
)

def setUpModule():
  # Supply every version of the software.
  installSoftwareUrlList(
    SlapOSInstanceTestCase,
    software_urls,
    debug=bool(int(os.environ.get('SLAPOS_TEST_DEBUG', 0))),
  )

class SlaposTestingTestCase(SlapOSInstanceTestCase):
  @classmethod
  def requestDefaultInstance(cls, state='started'):
    # This method is called for requesting and destroying (state='destroyed').
    for name, url in zip(software_files, software_urls):
      computer_partition = cls.slap.request(
        software_release=url,
        software_type=None, # default
        partition_reference='Instance_of_' + name,
        partition_parameter_kw=cls._instance_parameter_dict,
        state=state,
      )
    # one of the requested computer partitions
    # to satisfy slapos.testing.testcase (slapos.core < 1.13.0)
    # and to make it call waitForInstance (slapos.core >= 1.13.0).
    return computer_partition

  def test(self):
    # Just test that each version of the software compiles and instantiates.
    # Check that all expected instances have been requested.
    cp = self.slap.computer.getComputerPartitionList()
    requested = {
      p.getSoftwareRelease()._software_release: p.getConnectionParameterDict()
      for p in self.slap.computer.getComputerPartitionList()
      if p.getState() == 'started'
    }
    self.assertEqual(set(requested.keys()), set(software_urls))
    self.assertTrue(all('environment-script' in d for d in requested.values()))
