#!/usr/bin/python

# -*- coding: utf-8 -*-

#

# 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) 2008, 2016, Oracle and/or its affiliates. All rights reserved.

#

import testutils

if __name__ == "__main__":

        testutils.setup_environment("../../../proto")

import pkg5unittest

import errno

import os

import platform

import re

import shutil

import socket

import subprocess

import stat

import tempfile

import time

import unittest

import urllib2

import pkg.actions

import pkg.digest as digest

import pkg.fmri as fmri

import pkg.manifest as manifest

import pkg.portable as portable

from pkg.client.pkgdefs import EXIT_OOPS

try:

        import pkg.sha512

        sha512_supported = True

except ImportError:

        sha512_supported = False

class _TestHelper(object):

        """Private helper class for shared functionality between test

        classes."""

        def _assertEditables(self, moved=[], removed=[], installed=[],

            updated=[]):

                """Private helper function that verifies that expected editables

                are listed in parsable output.  If no editable of a given type

                is specified, then no editable files are expected."""

                changed = []

                if moved:

                        changed.append(['moved', moved])

                if removed:

                        changed.append(['removed', removed])

                if installed:

                        changed.append(['installed', installed])

                if updated:

                        changed.append(['updated', updated])

                self.assertEqualParsable(self.output,

                        include=["change-editables"],

                        change_editables=changed)

class TestPkgInstallBasics(pkg5unittest.SingleDepotTestCase):

        # Only start/stop the depot once (instead of for every test)

        persistent_setup = True

        foo10 = """

            open [email protected],5.11-0

            close """

        foo11 = """

            open [email protected],5.11-0

            add dir mode=0755 owner=root group=bin path=/lib

            add file tmp/libc.so.1 mode=0555 owner=root group=bin path=/lib/libc.so.1 timestamp="20080731T024051Z"

            close """

        foo11_timestamp = 1217472051

        foo12 = """

            open [email protected],5.11-0

            add file tmp/libc.so.1 mode=0555 owner=root group=bin path=/lib/libc.so.1

            close """

        afoo10 = """

            open a/[email protected],5.11-0

            close """

        boring10 = """

            open [email protected],5.11-0

            close """

        boring11 = """

            open [email protected],5.11-0

            close """

        bar10 = """

            open [email protected],5.11-0

            add depend type=require fmri=pkg:/[email protected]

            add dir mode=0755 owner=root group=bin path=/bin

            add file tmp/cat mode=0555 owner=root group=bin path=/bin/cat

            close """

        bar11 = """

            open [email protected],5.11-0

            add depend type=require fmri=pkg:/[email protected]

            add dir mode=0755 owner=root group=bin path=/bin

            add file tmp/cat mode=0555 owner=root group=bin path=/bin/cat

            close """

        xfoo10 = """

            open [email protected],5.11-0

            close """

        xbar10 = """

            open [email protected],5.11-0

            add depend type=require fmri=pkg:/[email protected]

            add dir mode=0755 owner=root group=bin path=/bin

            add file tmp/cat mode=0555 owner=root group=bin path=/bin/cat

            close """

        xbar11 = """

            open [email protected],5.11-0

            add depend type=require fmri=pkg:/[email protected]

            add dir mode=0755 owner=root group=bin path=/bin

            add file tmp/cat mode=0555 owner=root group=bin path=/bin/cat

            close """

        bar12 = """

            open [email protected],5.11-0

            add depend type=require fmri=pkg:/[email protected]

            add dir mode=0755 owner=root group=bin path=/bin

            add file tmp/cat mode=0555 owner=root group=bin path=/bin/cat

            close """

        baz10 = """

            open [email protected],5.11-0

            add depend type=require fmri=pkg:/[email protected]

            add dir mode=0755 owner=root group=bin path=/bin

            add file tmp/baz mode=0555 owner=root group=bin path=/bin/baz

            close """

        deep10 = """

            open [email protected],5.11-0

            add depend type=require fmri=pkg:/[email protected]

            add dir mode=0755 owner=root group=bin path=/bin

            add file tmp/cat mode=0555 owner=root group=bin path=/bin/cat

            close """

        xdeep10 = """

            open [email protected],5.11-0

            add depend type=require fmri=pkg:/[email protected]

            add dir mode=0755 owner=root group=bin path=/bin

            add file tmp/cat mode=0555 owner=root group=bin path=/bin/cat

            close """

        ydeep10 = """

            open [email protected],5.11-0

            add depend type=require fmri=pkg:/[email protected]

            add dir mode=0755 owner=root group=bin path=/bin

            add file tmp/cat mode=0555 owner=root group=bin path=/bin/cat

            close """

        a6018_1 = """

            open [email protected],5.11-0

            close """

        a6018_2 = """

            open [email protected],5.11-0

            close """

        b6018_1 = """

            open [email protected],5.11-0

            add depend type=optional fmri=a6018@1

            close """

        badfile10 = """

            open [email protected],5.11-0

            add file tmp/baz mode=644 owner=root group=bin path=/tmp/baz-file

            close """

        baddir10 = """

            open [email protected],5.11-0

            add dir mode=755 owner=root group=bin path=/tmp/baz-dir

            close """

        a16189 = """

            open [email protected],5.11-0

            add depend type=require fmri=pkg:/[email protected]

            close """

        b16189 = """

            open [email protected],5.11-0

            add dir mode=0755 owner=root group=bin path=/bin

            add file tmp/cat mode=0555 owner=root group=bin path=/bin/cat

            close """

        fuzzy = """

            open [email protected],5.11-0

            add dir mode=0755 owner=root group=bin path="opt/dir with white\tspace"

            add file tmp/cat mode=0644 owner=root group=bin path="opt/dir with white\tspace/cat in a hat"

            close

            open [email protected],5.11-0

            add dir mode=0755 owner=root group=bin path="opt/dir with white\tspace"

            add file tmp/cat mode=0644 owner=root group=bin path="opt/dir with white\tspace/cat in a hat"

            add link path=etc/cat_link target="../opt/dir with white\tspace/cat in a hat"

            close """

        ffoo10 = """

            open [email protected],5.11-0

            add file tmp/libc.so.1 mode=0555 owner=root group=bin path=/lib/libc.so.1

            close """

        ffoo11 = """

            open [email protected],5.11-0

            add file tmp/libc.so.1 mode=0555 owner=root group=bin path=/lib/libc.so.1

            close """

        fbar10 = """

            open [email protected],5.11-0

            add depend type=require fmri=pkg:/[email protected]

            add dir mode=0755 owner=root group=bin path=/bin

            add file tmp/cat mode=0555 owner=root group=bin path=/bin/cat

            close """

        fbar11 = """

            open [email protected],5.11-0

            add depend type=require fmri=pkg:/[email protected]

            add dir mode=0755 owner=root group=bin path=/bin

            add file tmp/cat mode=0555 owner=root group=bin path=/bin/cät

            close """

        secret1 = """

            open [email protected]

            add dir mode=0755 owner=root group=bin path=/p1

            add file tmp/cat mode=0555 owner=root group=bin sysattr=TH path=/p1/cat

            close """

        secret2 = """

            open [email protected]

            add dir mode=0755 owner=root group=bin path=/p2

            add file tmp/cat mode=0555 owner=root group=bin sysattr=hidden,sensitive path=/p2/cat

            close """

        secret3 = """

            open [email protected]

            add dir mode=0755 owner=root group=bin path=/p3

            add file tmp/cat mode=0555 owner=root group=bin sysattr=horst path=/p3/cat

            close """

        secret4 = """

            open [email protected]

            add dir mode=0755 owner=root group=bin path=/p3

            add file tmp/cat mode=0555 owner=root group=bin sysattr=hidden,horst path=/p3/cat

            close """

        misc_files = [ "tmp/libc.so.1", "tmp/cat", "tmp/baz" ]

        def setUp(self):

                pkg5unittest.SingleDepotTestCase.setUp(self)

                self.make_misc_files(self.misc_files)

        def test_cli(self):

                """Test bad cli options"""

                self.cli_helper("install")

                self.cli_helper("exact-install")

        def cli_helper(self, install_cmd):

                self.image_create(self.rurl)

                self.pkg("-@", exit=2)

                self.pkg("-s status", exit=2)

                self.pkg("-R status", exit=2)

                self.pkg("%s -@ foo" % install_cmd, exit=2)

                self.pkg("%s -vq foo" % install_cmd, exit=2)

                self.pkg("%s" % install_cmd, exit=2)

                self.pkg("%s [email protected]" % install_cmd, exit=1)

                self.pkg("%s pkg:/[email protected]" % install_cmd, exit=1)

        def test_basics_1_install(self):

                """ Send empty package [email protected], install and uninstall """

                plist = self.pkgsend_bulk(self.rurl, self.foo10)

                self.image_create(self.rurl)

                self.pkg("list -a")

                self.pkg("list", exit=1)

                self.pkg("install --parsable=0 foo")

                self.assertEqualParsable(self.output,

                    add_packages=plist)

                self.pkg("list")

                self.pkg("verify")

                self.pkg("uninstall --parsable=0 foo")

                self.assertEqualParsable(self.output,

                    remove_packages=plist)

                self.pkg("verify")

        def test_basics_1_exact_install(self):

                """ Send empty package [email protected], exact-install and uninstall """

                plist = self.pkgsend_bulk(self.rurl, self.foo10)

                self.image_create(self.rurl)

                self.pkg("list -a")

                self.pkg("list", exit=1)

                self.pkg("exact-install --parsable=0 foo")

                self.assertEqualParsable(self.output,

                    add_packages=plist)

                # Exact-install the same version should do nothing.

                self.pkg("exact-install foo", exit=4)

                self.pkg("list")

                self.pkg("verify")

                self.pkg("uninstall --parsable=0 foo")

                self.assertEqualParsable(self.output,

                    remove_packages=plist)

                self.pkg("verify")

        def test_basics_2(self):

                """ Send package [email protected], containing a directory and a file,

                    install or exact-install, search, and uninstall. """

                self.basics_2_helper("install")

                self.basics_2_helper("exact-install")

        def basics_2_helper(self, install_cmd):

                # This test needs to use the depot to be able to test the

                # download cache.

                self.dc.start()

                self.pkgsend_bulk(self.durl, (self.foo10, self.foo11),

                    refresh_index=True)

                self.image_create(self.durl)

                self.pkg("list -a")

                self.pkg("%s foo" % install_cmd)

                # Verify that content cache is empty after successful install

                # or exact-install.

                api_inst = self.get_img_api_obj()

                img_inst = api_inst.img

                cache_dirs = []

                for path, readonly, pub, layout in img_inst.get_cachedirs():

                        if os.path.exists(path):

                                cache_dirs.extend(os.listdir(path))

                self.assertEqual(cache_dirs, [])

                self.pkg("verify")

                self.pkg("list")

                self.pkg("search -l /lib/libc.so.1")

                self.pkg("search -r /lib/libc.so.1")

                self.pkg("search -l blah", exit=1)

                self.pkg("search -r blah", exit=1)

                # check to make sure timestamp was set to correct value

                libc_path = os.path.join(self.get_img_path(), "lib/libc.so.1")

                lstat = os.stat(libc_path)

                assert (lstat[stat.ST_MTIME] == self.foo11_timestamp)

                # check that verify finds changes

                now = time.time()

                os.utime(libc_path, (now, now))

                self.pkg("verify", exit=1)

                self.pkg("uninstall foo")

                self.pkg("verify")

                self.pkg("list -a")

                self.pkg("verify")

                self.dc.stop()

        def test_basics_3(self):

                """Exact-install or Install [email protected], upgrade to [email protected],

                uninstall. """

                self.basics_3_helper("install")

                self.basics_3_helper("exact-install")

        def basics_3_helper(self, installed_cmd):

                # This test needs to use the depot to be able to test the

                # download cache.

                self.dc.start()

                self.pkgsend_bulk(self.durl, (self.foo10, self.foo11))

                self.image_create(self.durl)

                self.pkg("set-property flush-content-cache-on-success False")

                # Verify that content cache is empty before install or

                # exact-install.

                api_inst = self.get_img_api_obj()

                img_inst = api_inst.img

                cache_dirs = []

                for path, readonly, pub, layout in img_inst.get_cachedirs():

                        if os.path.exists(path):

                                cache_dirs.extend(os.listdir(path))

                self.assertEqual(cache_dirs, [])

                self.pkg("%s [email protected]" % installed_cmd)

                self.pkg("list [email protected]")

                self.pkg("list [email protected]", exit=1)

                self.pkg("%s [email protected]" % installed_cmd)

                # Verify that content cache is not empty after successful

                # install or exact_install (since

                # flush-content-cache-on-success is True by default) for

                # packages that have content.

                cache_dirs = []

                for path, readonly, pub, layout in img_inst.get_cachedirs():

                        if os.path.exists(path):

                                cache_dirs.extend(os.listdir(path))

                self.assertNotEqual(cache_dirs, [])

                self.pkg("list [email protected]")

                self.pkg("list [email protected]", exit=1)

                self.pkg("list foo@1")

                self.pkg("verify")

                self.pkg("uninstall foo")

                self.pkg("list -a")

                self.pkg("verify")

                self.dc.stop()

        def test_basics_4(self):

                """ Add [email protected], dependent on [email protected], exact-install or

                install, uninstall. """

                self.basics_4_helper("install")

                self.basics_4_helper("exact-install")

        def basics_4_helper(self, installed_cmd):

                # This test needs to use the depot to be able to test the

                # download cache.

                self.dc.start()

                self.pkgsend_bulk(self.durl, (self.foo10, self.foo11,

                    self.bar10))

                self.image_create(self.durl)

                # Set content cache to not be flushed on success.

                self.pkg("set-property flush-content-cache-on-success False")

                # Verify that content cache is empty before install or

                # exact-install.

                api_inst = self.get_img_api_obj()

                img_inst = api_inst.img

                cache_dirs = []

                for path, readonly, pub, layout in img_inst.get_cachedirs():

                        if os.path.exists(path):

                                cache_dirs.extend(os.listdir(path))

                self.assertEqual(cache_dirs, [])

                self.pkg("list -a")

                self.pkg("%s [email protected]" % installed_cmd)

                # Verify that content cache is not empty after successful

                # install or exact-install (since

                # flush-content-cache-on-success is False)

                # for packages that have content.

                cache_dirs = []

                for path, readonly, pub, layout in img_inst.get_cachedirs():

                        if os.path.exists(path):

                                cache_dirs.extend(os.listdir(path))