#

# CDDL HEADER START

#

# The contents of this file are subject to the terms of the

# Common Development and Distribution License (the "License").

# You may not use this file except in compliance with the License.

#

# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE

# or http://www.opensolaris.org/os/licensing.

# See the License for the specific language governing permissions

# and limitations under the License.

#

# When distributing Covered Code, include this CDDL HEADER in each

# file and include the License file at usr/src/OPENSOLARIS.LICENSE.

# If applicable, add the following below this CDDL HEADER, with the

# fields enclosed by brackets "[]" replaced with your own identifying

# information: Portions Copyright [yyyy] [name of copyright owner]

#

# CDDL HEADER END

#

#

# Copyright (c) 2010, 2011, Oracle and/or its affiliates. All rights reserved.

#

import difflib

import os

import platform

import re

import unittest

import osol_install.errsvc as errsvc

from lxml import etree

from solaris_install.auto_install.checkpoints.target_selection \

    import TargetSelection

from solaris_install.data_object import ObjectNotFoundError

from solaris_install.engine import InstallEngine

from solaris_install.engine.test.engine_test_utils import \

    get_new_engine_instance, reset_engine

from solaris_install.target import Target, logical

from solaris_install.target.physical import Disk

class  TestTargetSelectionTestCase(unittest.TestCase):

    DISCOVERED_TARGETS_XML = '''

    <root>

      <target name="discovered">

        <disk whole_disk="false">

          <disk_name name="c99t4d0" name_type="ctd"/>

          <disk_prop dev_type="FIXED" dev_vendor="Lenovo"

          dev_size="625141760secs"/>

          <partition action="preserve" name="1" part_type="191">

            <size val="276976665secs" start_sector="512"/>

            <slice name="1" action="preserve" force="false" is_swap="false"

               in_zpool="rpool" in_vdev="rpool-none">

              <size val="1060290secs" start_sector="512"/>

            </slice>

          </partition>

        </disk>

        <disk whole_disk="false">

          <disk_name name="c99t3d0" name_type="ctd"/>

          <disk_prop dev_type="FIXED" dev_vendor="Lenovo"

           dev_size="625141760secs"/>

          <partition action="preserve" name="1" part_type="11">

            <size val="3341520secs" start_sector="0"/>

          </partition>

        </disk>

        <disk whole_disk="false">

          <disk_name name="c99t2d0" name_type="ctd"/>

          <disk_prop dev_type="FIXED" dev_vendor="Lenovo"

           dev_size="625141760secs"/>

          <partition action="preserve" name="1" part_type="191">

            <size val="348144615secs" start_sector="0"/>

            <slice name="1" action="preserve" force="false" is_swap="false"

               in_zpool="rpool" in_vdev="rpool-none">

              <size val="1060290secs" start_sector="48195"/>

            </slice>

            <slice name="3" action="preserve" force="false" is_swap="false"

             in_zpool="ai_test_rpool" in_vdev="rpool-mirror-0">

              <size val="43022070secs" start_sector="1108485"/>

            </slice>

            <slice name="7" action="preserve" force="false" is_swap="false">

              <size val="190257795secs" start_sector="44130555"/>

            </slice>

            <slice name="8" action="preserve" force="false" is_swap="false">

              <size val="16065secs" start_sector="0"/>

            </slice>

          </partition>

        </disk>

        <disk whole_disk="false">

          <disk_name name="c99t1d0" name_type="ctd"/>

          <disk_prop dev_type="FIXED" dev_vendor="Lenovo"

           dev_size="625141760secs"/>

          <partition action="preserve" name="1" part_type="191">

            <size val="348144615secs" start_sector="0"/>

          </partition>

        </disk>

        <disk whole_disk="false">

          <disk_name name="c99t0d0" name_type="ctd"/>

          <disk_prop dev_type="FIXED" dev_vendor="Lenovo"

           dev_size="625141760secs"/>

          <partition action="preserve" name="1" part_type="131">

            <size val="348144615secs" start_sector="0"/>

          </partition>

          <partition action="preserve" name="2" part_type="130">

            <size val="276976665secs" start_sector="348160680"/>

            <slice name="1" action="preserve" force="false" is_swap="false"

               in_zpool="rpool" in_vdev="rpool-none">

              <size val="1060290secs" start_sector="48195"/>

            </slice>

            <slice name="2" action="preserve" force="false" is_swap="false">

              <size val="276944535secs" start_sector="0"/>

            </slice>

            <slice name="3" action="preserve" force="false" is_swap="false"

             in_zpool="ai_test_rpool" in_vdev="rpool-mirror-0">

              <size val="43022070secs" start_sector="1108485"/>

            </slice>

            <slice name="7" action="preserve" force="false" is_swap="false">

              <size val="190257795secs" start_sector="44130555"/>

            </slice>

            <slice name="8" action="preserve" force="false" is_swap="false">

              <size val="16065secs" start_sector="0"/>

            </slice>

            <slice name="9" action="preserve" force="false" is_swap="false">

              <size val="32129secs" start_sector="16066"/>

            </slice>

          </partition>

        </disk>

        <disk whole_disk="false">

          <disk_name name="c97d0" name_type="ctd"/>

          <disk_prop dev_type="FIXED" dev_size="390715392secs"/>

          <disk_keyword key="boot_disk"/>

          <partition action="preserve" name="1" part_type="175">

            <size val="401625secs" start_sector="0"/>

          </partition>

          <partition action="preserve" name="2" part_type="175">

            <size val="133949970secs" start_sector="401625"/>

          </partition>

          <partition action="preserve" name="3" part_type="130">

            <size val="234420480secs" start_sector="134367660"/>

            <slice name="1" action="preserve" force="false" is_swap="false">

              <size val="1060290secs" start_sector="48195"/>

            </slice>

            <slice name="2" action="preserve" force="false" is_swap="false">

              <size val="234388350secs" start_sector="0"/>

            </slice>

            <slice name="3" action="preserve" force="false" is_swap="false">

              <size val="43022070secs" start_sector="1108485"/>

            </slice>

            <slice name="7" action="preserve" force="false" is_swap="false">

              <size val="190257795secs" start_sector="44130555"/>

            </slice>

            <slice name="8" action="preserve" force="false" is_swap="false">

              <size val="16065secs" start_sector="0"/>

            </slice>

            <slice name="9" action="preserve" force="false" is_swap="false">

              <size val="32130secs" start_sector="16065"/>

            </slice>

          </partition>

        </disk>

        <disk whole_disk="false">

          <disk_name name="c97d1" name_type="ctd"/>

          <disk_prop dev_type="FIXED" dev_size="390715392secs"/>

            <partition action="create" name="1" part_type="191">

            <size val="390714880secs" start_sector="512"/>

            <slice name="0" action="create" force="false" is_swap="false">

              <size val="390713344secs" start_sector="512"/>

            </slice>

          </partition>

        </disk>

        <disk whole_disk="false">

          <disk_name name="c98d0" name_type="ctd"/>

          <disk_prop dev_type="FIXED" dev_size="390715392secs"/>

            <partition action="create" name="1" part_type="191">

            <size val="390714880secs" start_sector="512"/>

            <slice name="0" action="create" force="false" is_swap="false">

              <size val="390713344secs" start_sector="512"/>

            </slice>

          </partition>

        </disk>

        <disk whole_disk="false">

          <disk_name name="c98d1" name_type="ctd"/>

          <disk_prop dev_type="FIXED" dev_size="390715392secs"/>

            <partition action="create" name="1" part_type="191">

            <size val="390714880secs" start_sector="512"/>

            <slice name="0" action="create" force="false" is_swap="false">

              <size val="390713344secs" start_sector="512"/>

            </slice>

          </partition>

        </disk>

        <disk whole_disk="false">

          <disk_name name="c95d0" name_type="ctd"/>

          <disk_prop dev_type="FIXED" dev_size="390715392secs"/>

            <partition action="create" name="1" part_type="191">

            <size val="390714880secs" start_sector="512"/>

            <slice name="0" action="create" force="false" is_swap="false">

              <size val="390713344secs" start_sector="512"/>

            </slice>

          </partition>

        </disk>

        <disk whole_disk="false">

          <disk_name name="c95d1" name_type="ctd"/>

          <disk_prop dev_type="FIXED" dev_size="390715392secs"/>

            <partition action="create" name="1" part_type="191">

            <size val="390714880secs" start_sector="512"/>

            <slice name="0" action="create" force="false" is_swap="false">

              <size val="390713344secs" start_sector="512"/>

            </slice>

          </partition>

        </disk>

        <disk whole_disk="false">

          <disk_name name="c96d0" name_type="ctd"/>

          <disk_prop dev_type="FIXED" dev_size="29.98gb"/>

            <partition action="preserve" name="1" part_type="12">

              <size val="2.99Gb" start_sector="16065"/>

            </partition>

            <partition action="preserve" name="2" part_type="131">

              <size val="2.99Gb" start_sector="6286550"/>

            </partition>

            <partition action="preserve" name="3" part_type="12">

              <size val="2.99Gb" start_sector="12557035"/>

            </partition>

            <partition action="preserve" name="4" part_type="5">

              <size val="14.99Gb" start_sector="18827520"/>

            </partition>

            <partition action="preserve" name="5" part_type="12">

              <size val="1.5Gb" start_sector="18827520"/>

            </partition>

            <partition action="preserve" name="6" part_type="191">

              <size val="5.5Gb" start_sector="21973248"/>

            </partition>

        </disk>

        <logical noswap="true" nodump="true">

          <zpool name="export" action="preserve" is_root="false"

           mountpoint="/export">

            <vdev name="export-mirror-0" redundancy="mirror-0"/>

            <filesystem name="home" action="preserve"

             mountpoint="/export/home"/>

            <filesystem name="synchronized" action="preserve"

             mountpoint="/export/synchronized"/>

            <filesystem name="test_install" action="preserve"

             mountpoint="/a"/>

          </zpool>

          <zpool name="ai_test_rpool" action="preserve" is_root="true"

           mountpoint="/rpool">

            <vdev name="rpool-none" redundancy="none"/>

            <vdev name="rpool-mirror-0" redundancy="mirror-0"/>

            <filesystem name="ROOT" action="preserve" mountpoint="none"/>

            <filesystem name="ROOT/os153" action="preserve" mountpoint="/"/>

            <filesystem name="ROOT/os158" action="preserve" mountpoint="/"/>

            <filesystem name="ROOT/os159" action="preserve" mountpoint="/"/>

            <filesystem name="ROOT/os161" action="preserve" mountpoint="/"/>

            <zvol name="dump" action="preserve" use="none">

              <size val="1.50gb"/>

            </zvol>

            <zvol name="swap" action="preserve" use="none">

              <size val="1.00gb"/>

            </zvol>

            <be name="os153"/>

            <be name="os158"/>

            <be name="os159"/>

            <be name="os161"/>

          </zpool>

        </logical>

      </target>

    </root>

    '''

    def __gendiff_str(self, a, b):

        a_lines = a.splitlines()

        b_lines = b.splitlines()

        return "\n".join(list(difflib.ndiff(a_lines, b_lines)))

    def __run_simple_test(self, input_xml, expected_xml, fail_ex_str=None,

        dry_run=True):

        '''Run a simple test where given specific xml in the manifest, we

        validate that the generated DESIRED tree is as expected.

        'expected_xml' should have the values indented using '.' instead of

        spaces to ensure that perfect match is made.

        '''

        errsvc.clear_error_list()

        # Different processor to what these tests were written for.

        if platform.processor() != 'i386':

            print "Skipping test on wrong arch"

            return

        if input_xml is not None:

            manifest_dom = etree.fromstring(input_xml)

            self.doc.import_from_manifest_xml(manifest_dom, volatile=True)

            self.doc.logger.debug("DOC AFTER IMPORT TEST XML:\n%s\n\n" %

                                  (str(self.doc)))

            if len(errsvc._ERRORS) > 0:

                self.fail(errsvc._ERRORS[0])

        # Define expected string, compensate for indent. Using '.' in expected

        # string to remove conflict with indent replacement.

        indentation = '''\

        '''

        expected_xml = expected_xml.replace(indentation, "").replace(".", " ")

        try:

            self.target_selection.select_targets(

                self.doc.volatile.get_descendants(class_type=Target,

                                                  max_depth=2),

                self.doc.persistent.get_first_child(Target.DISCOVERED),

                dry_run=dry_run)

            if (fail_ex_str is not None):

                self.fail("Expected failure but test succeeded.")

        except Exception, ex:

            if (fail_ex_str is not None):

                self.assertEquals(str(ex), fail_ex_str)

            else:

                import traceback

                traceback.print_exc()

                raise ex

        try:

            desired = \

                self.doc.get_descendants(

                    name=Target.DESIRED, class_type=Target, max_depth=2,

                    not_found_is_err=True)[0]

            xml_str = desired.get_xml_tree_str()

            expected_re = re.compile(expected_xml)

            if not expected_re.match(xml_str):

                self.fail("Resulting XML doesn't match expected:\nDIFF:\n%s\n"

                          % self.__gendiff_str(expected_xml, xml_str))

            desired.final_validation()

        except ObjectNotFoundError:

            self.fail("Unable to find DESIRED tree!")

        except Exception, e:

            import traceback

            traceback.print_exc()

            self.fail(e)

        if len(errsvc._ERRORS) > 0:

            self.fail(errsvc._ERRORS[0])

    def setUp(self):

        logical.DEFAULT_BE_NAME = "ai_test_solaris"

        self.engine = get_new_engine_instance()

        self.target_selection = TargetSelection("Test Checkpoint")

        self.doc = InstallEngine.get_instance().data_object_cache

        discovered_dom = etree.fromstring(self.DISCOVERED_TARGETS_XML)

        self.doc.import_from_manifest_xml(discovered_dom, volatile=False)

        # As we are not really discovering disks, label  will be set to "None"

        # Ensure they set to VTOC

        discovered = self.doc.persistent.get_first_child(Target.DISCOVERED)

        self.disks = discovered.get_descendants(class_type=Disk)

        for disk in self.disks:

            if disk.label is None:

                disk.label = "VTOC"

    def tearDown(self):

        if self.engine is not None:

            reset_engine(self.engine)

        self.doc = None

        self.target_selection = None

    def test_target_selection_no_target(self):

        '''Test Success if no target in manifest'''

        expected_xml = '''\

        <target name="desired">

        ..<disk whole_disk="false">

        ....<disk_name name="c97d0" name_type="ctd"/>

        ....<disk_prop dev_type="FIXED" dev_size="390715392secs"/>

        ....<disk_keyword key="boot_disk"/>

        ....<partition action="create" name="1" part_type="191">

        ......<size val="390714880secs" start_sector="512"/>

        ......<slice name="0" action="create" force="true" is_swap="false" \

        in_zpool="rpool" in_vdev="vdev">

        ........<size val="390713344secs" start_sector="512"/>

        ......</slice>

        ....</partition>

        ..</disk>

        ..<logical noswap="false" nodump="false">

        ....<zpool name="rpool" action="create" is_root="true">

        ......<vdev name="vdev" redundancy="none"/>

        ......<be name="ai_test_solaris"/>

        ......<zvol name="swap" action="create" use="swap">

        ........<size val="\d+m"/>

        ......</zvol>

        ......<zvol name="dump" action="create" use="dump">

        ........<size val="\d+m"/>

        ......</zvol>

        ....</zpool>

        ..</logical>

        </target>

        '''

        self.__run_simple_test(None, expected_xml)

    def test_target_selection_no_disk_target_with_logical(self):

        '''Test Success if no disk targets, but with a logical section'''

        test_manifest_xml = '''

        <auto_install>

           <ai_instance name="orig_default">

             <target>

               <logical>

                 <zpool name="ai_test_rpool" is_root="true">

                   <filesystem name="/export"/>

                   <filesystem name="/export/home"/>

                   <be name="ai_test_solaris"/>

                 </zpool>

               </logical>

             </target>

          </ai_instance>

        </auto_install>

        '''

        expected_xml = '''\

        <target name="desired">

        ..<logical noswap="false" nodump="false">

        ....<zpool name="ai_test_rpool" action="create" is_root="true">

        ......<filesystem name="/export" action="create" in_be="false"/>

        ......<filesystem name="/export/home" action="create" in_be="false"/>

        ......<be name="ai_test_solaris"/>

        ......<vdev name="vdev" redundancy="none"/>

        ......<zvol name="swap" action="create" use="swap">

        ........<size val="\d+m"/>

        ......</zvol>

        ......<zvol name="dump" action="create" use="dump">

        ........<size val="\d+m"/>

        ......</zvol>

        ....</zpool>

        ..</logical>

        ..<disk whole_disk="false">

        ....<disk_name name="c97d0" name_type="ctd"/>

        ....<disk_prop dev_type="FIXED" dev_size="390715392secs"/>

        ....<disk_keyword key="boot_disk"/>

        ....<partition action="create" name="1" part_type="191">

        ......<size val="390714880secs" start_sector="512"/>

        ......<slice name="0" action="create" force="true" is_swap="false" \

        in_zpool="ai_test_rpool" in_vdev="vdev">

        ........<size val="390713344secs" start_sector="512"/>

        ......</slice>

        ....</partition>

        ..</disk>

        </target>

        '''

        self.__run_simple_test(test_manifest_xml, expected_xml)

    def test_target_selection_single_whole_disk_target(self):

        '''Test Success if single whole target in manifest'''

        test_manifest_xml = '''

        <auto_install>

          <ai_instance auto_reboot="false">

            <target>

              <disk whole_disk="true">

                <disk_name name="c99t0d0" name_type="ctd"/>

              </disk>

              <logical noswap="true" nodump="true"/>

            </target>

          </ai_instance>

        </auto_install>

        '''

        expected_xml = '''\

        <target name="desired">

        ..<disk whole_disk="false">

        ....<disk_name name="c99t0d0" name_type="ctd"/>

        ....<disk_prop dev_type="FIXED" dev_vendor="Lenovo" \

        dev_size="625141760secs"/>

        ....<partition action="create" name="1" part_type="191">

        ......<size val="625141248secs" start_sector="512"/>

        ......<slice name="0" action="create" force="true" is_swap="false" \

        in_zpool="rpool" in_vdev="vdev">

        ........<size val="625139712secs" start_sector="512"/>

        ......</slice>

        ....</partition>

        ..</disk>

        ..<logical noswap="true" nodump="true">

        ....<zpool name="rpool" action="create" is_root="true">

        ......<vdev name="vdev" redundancy="none"/>

        ......<be name="ai_test_solaris"/>

        ....</zpool>

        ..</logical>

        </target>

        '''

        self.__run_simple_test(test_manifest_xml, expected_xml)

    def test_target_selection_boot_disk_target(self):

        '''Test Success if boot_disk target in manifest'''

        test_manifest_xml = '''

        <auto_install>

          <ai_instance auto_reboot="false">

            <target>

              <disk whole_disk="true" in_zpool="ai_test_rpool" in_vdev="vdev">

                <disk_keyword key="boot_disk" />

              </disk>

              <logical>

                <zpool name="ai_test_rpool" is_root="true">

                  <vdev name="vdev" redundancy="none" />

                </zpool>

              </logical>

            </target>

          </ai_instance>

        </auto_install>

        '''

        expected_xml = '''\

        <target name="desired">

        ..<logical noswap="false" nodump="false">

        ....<zpool name="ai_test_rpool" action="create" is_root="true">

        ......<vdev name="vdev" redundancy="none"/>