#!/usr/bin/python

#

# 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

#

import testutils

if __name__ == "__main__":

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

import pkg5unittest

import os

import pkg.fmri as fmri

import pkg.portable as portable

import pkg.misc as misc

import pkg.p5p

import shutil

import stat

import tempfile

import unittest

class TestPkgCompositePublishers(pkg5unittest.ManyDepotTestCase):

        # Don't discard repository or setUp() every test.

        persistent_setup = True

        # Tests in this suite use the read only data directory.

        need_ro_data = True

        foo_pkg = """

            open pkg://test/[email protected]

            add set name=pkg.summary value="Example package foo."

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

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

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

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

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

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

            add dir mode=0755 owner=root group=bin path=usr/share/doc

            add dir mode=0755 owner=root group=bin path=usr/share/doc/foo

            add dir mode=0755 owner=root group=bin path=usr/share/man

            add dir mode=0755 owner=root group=bin path=usr/share/man/man1

            add file tmp/foo mode=0755 owner=root group=bin path=usr/bin/foo

            add file tmp/libfoo.so.1 mode=0755 owner=root group=bin path=lib/libfoo.so.1 variant.debug.foo=false

            add file tmp/libfoo_debug.so.1 mode=0755 owner=root group=bin path=lib/libfoo.so.1 variant.debug.foo=true

            add file tmp/foo.1 mode=0444 owner=root group=bin path=usr/share/man/man1/foo.1 facet.doc.man=true

            add file tmp/README mode=0444 owner=root group=bin path=/usr/share/doc/foo/README

            add link path=usr/local/bin/soft-foo target=usr/bin/foo

            add hardlink path=usr/local/bin/hard-foo target=/usr/bin/foo

            close """

        incorp_pkg = """

            open pkg://test/[email protected]

            add set name=pkg.summary value="Incorporation"

            add depend type=incorporate [email protected],5.11-0.1

            close

            open pkg://test/[email protected]

            add set name=pkg.summary value="Incorporation"

            add depend type=incorporate [email protected],5.11-0.2

            close """

        signed_pkg = """

            open pkg://test/[email protected]

            add depend type=require [email protected]

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

            add file tmp/quux mode=0755 owner=root group=bin path=usr/bin/quark

            add set name=authorized.species value=bobcat

            close """

        quux_pkg = """

            open pkg://test2/[email protected],5.11-0.1

            add set name=pkg.summary value="Example package quux."

            add depend type=require fmri=pkg:/incorp

            close

            open pkg://test2/[email protected],5.11-0.2

            add set name=pkg.summary value="Example package quux."

            add depend type=require fmri=pkg:/incorp

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

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

            add file tmp/quux mode=0755 owner=root group=bin path=usr/bin/quux

            close """

        misc_files = ["tmp/foo", "tmp/libfoo.so.1", "tmp/libfoo_debug.so.1",

            "tmp/foo.1", "tmp/README", "tmp/LICENSE", "tmp/quux"]

        def __seed_ta_dir(self, certs, dest_dir=None):

                if isinstance(certs, basestring):

                        certs = [certs]

                if not dest_dir:

                        dest_dir = self.ta_dir

                self.assert_(dest_dir)

                self.assert_(self.raw_trust_anchor_dir)

                for c in certs:

                        portable.copyfile(

                            os.path.join(self.raw_trust_anchor_dir, name),

                            os.path.join(dest_dir, name))

        def __publish_packages(self, rurl):

                """Private helper function to publish packages needed for

                testing.

                """

                pkgs = "".join([self.foo_pkg, self.incorp_pkg, self.signed_pkg,

                    self.quux_pkg])

                # Publish packages needed for tests.

                plist = self.pkgsend_bulk(rurl, pkgs)

                # Sign the 'signed' package.

                r = self.get_repo(self.dcs[1].get_repodir())

                          "ch1_ta1_cert.pem"),

                          "ch2_ta1_cert.pem"),

                          "ch3_ta1_cert.pem"),

                          "ch4_ta1_cert.pem"),

                          "ch5_ta1_cert.pem"),

                          "ch1_ta3_cert.pem"),

                self.pkgsign(rurl, sign_args)

                # This is just a test assertion to verify that the

                # package was signed as expected.

                self.image_create(rurl, prefix=None)

                self.__seed_ta_dir("ta1")

                self.pkg("set-property signature-policy verify")

                self.pkg("install signed")

                self.image_destroy()

                return [

                    fmri.PkgFmri(sfmri)

                    for sfmri in plist

                ]

        def __archive_packages(self, arc_name, repo, plist):

                """Private helper function to archive packages needed for

                testing.

                """

                arc_path = os.path.join(self.test_root, arc_name)

                assert not os.path.exists(arc_path)

                arc = pkg.p5p.Archive(arc_path, mode="w")

                for pfmri in plist:

                        arc.add_repo_package(pfmri, repo)

                arc.close()

                return arc_path

        def setUp(self):

                pkg5unittest.ManyDepotTestCase.setUp(self, ["test", "test",

                    "test", "empty", "void"])

                self.make_misc_files(self.misc_files)

                # First repository will contain all packages.

                self.all_rurl = self.dcs[1].get_repo_url()

                # Second repository will contain only foo.

                self.foo_rurl = self.dcs[2].get_repo_url()

                # Third repository will contain only signed.

                self.signed_rurl = self.dcs[3].get_repo_url()

                # Fourth will be empty.

                self.empty_rurl = self.dcs[4].get_repo_url()

                # Fifth will have a publisher named 'void', but no packages.

                self.void_rurl = self.dcs[5].get_repo_url()

                # Setup base test paths.

                self.path_to_certs = os.path.join(self.ro_data_root,

                    "signing_certs", "produced")

                self.keys_dir = os.path.join(self.path_to_certs, "keys")

                self.cs_dir = os.path.join(self.path_to_certs,

                    "code_signing_certs")

                self.chain_certs_dir = os.path.join(self.path_to_certs,

                    "chain_certs")

                self.pub_cas_dir = os.path.join(self.path_to_certs,

                    "publisher_cas")

                self.inter_certs_dir = os.path.join(self.path_to_certs,

                    "inter_certs")

                self.raw_trust_anchor_dir = os.path.join(self.path_to_certs,

                    "trust_anchors")

                self.crl_dir = os.path.join(self.path_to_certs, "crl")

                # Publish packages.

                plist = self.__publish_packages(self.all_rurl)

                # Copy foo to second repository and build index.

                # Copy incorp and quux to third repository and build index.

                # Now create a package archive containing all packages, and

                # then one for each.

                repo = self.dcs[1].get_repo()

                self.all_arc = self.__archive_packages("all_pkgs.p5p", repo,

                    plist)

                for alist in ([plist[0]], [plist[1], plist[2]], [plist[3]],

                    [plist[4], plist[5]]):

                        arc_path = self.__archive_packages(

                self.ta_dir = None

                # Store FMRIs for later use.

                self.foo10 = plist[0]

                self.incorp10 = plist[1]

                self.incorp20 = plist[2]

                self.signed10 = plist[3]

                self.quux01 = plist[4]

                self.quux10 = plist[5]

        def test_00_list(self):

                """Verify that the list operation works as expected when

                compositing publishers.

                """

                # Create an image and verify no packages are known.

                self.image_create(self.empty_rurl, prefix=None)

                self.pkg("set-property signature-policy ignore")

                self.pkg("set-publisher --set-property signature-policy=ignore "

                    "test")

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

                # Verify list output for multiple, disparate sources using

                # different combinations of archives and repositories.

                    self.foo_rurl))

                self.pkg("list -afH")

                expected = \

                    ("foo (test) 1.0 ---\n"

                    "signed (test) 1.0 ---\n")

                output = self.reduceSpaces(self.output)

                self.assertEqualDiff(expected, output)

                # Verify removing origins while others remain configured

                # works as expected.

                self.pkg("list -afH")

                expected = "signed (test) 1.0 ---\n"

                output = self.reduceSpaces(self.output)

                self.assertEqualDiff(expected, output)

                # Verify simply adding origins works as expected.

                self.pkg("list -afH")

                expected = \

                    ("foo (test) 1.0 ---\n"

                    "incorp (test) 2.0 ---\n"

                    "incorp (test) 1.0 ---\n"

                    "quux (test2) 1.0-0.2 ---\n"

                    "quux (test2) 0.1-0.1 ---\n"

                    "signed (test) 1.0 ---\n")

                output = self.reduceSpaces(self.output)

                self.assertEqualDiff(expected, output)

                # Verify removing and adding origins at the same time works as

                # expected.

                    self.foo_rurl))

                self.pkg("list -afH")

                output = self.reduceSpaces(self.output)

                self.assertEqualDiff(expected, output)

                    self.quux_arc, self.all_arc, self.all_rurl))

                    self.all_rurl))

                output = self.reduceSpaces(self.output)

                self.assertEqualDiff(expected, output)

                # Verify packages can be installed from disparate sources and

                # show in default list output.

                self.pkg("install [email protected] quux signed")

                self.pkg("list -H")

                expected = \

                    ("foo (test) 1.0 i--\n"

                    "incorp (test) 1.0 i--\n"

                    "quux (test2) 0.1-0.1 i--\n"

                    "signed (test) 1.0 i--\n")

                output = self.reduceSpaces(self.output)

                self.assertEqualDiff(expected, output)

        def test_01_info(self):

                """Verify that the info operation works as expected when

                compositing publishers.

                """

		# because we compare date strings we must run this in

		# a consistent locale, which we made 'C'

		os.environ['LC_ALL'] = 'C'

                # Create an image and verify no packages are known.

                self.image_create(self.empty_rurl, prefix=None)

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

                # Verify info result for multiple disparate sources using

                # different combinations of archives and repositories.

                    self.foo_rurl))

                self.pkg("info -r [email protected] [email protected]")

                self.pkg("info -r [email protected] [email protected] [email protected] [email protected]")

                    self.foo_rurl))

                    self.signed_arc, self.incorp_arc, self.quux_arc,

                    self.foo_rurl))

                self.pkg("info -r [email protected] [email protected] [email protected] [email protected]")

                # Verify package installed from archive shows in default info

                # output.

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

                self.pkg("info")

                expected = """\

          Name: foo

       Summary: Example package foo.

         State: Installed

     Publisher: test

       Version: 1.0

        Branch: None

          Size: 41.00 B

                self.assertEqualDiff(expected, self.output)

        def test_02_contents(self):

                """Verify that the contents operation works as expected when

                compositing publishers.

                """

                # Create an image and verify no packages are known.

                self.image_create(self.empty_rurl, prefix=None)

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

                # Verify contents result for multiple disparate sources using

                # different combinations of archives and repositories.

                    self.foo_rurl))

                self.pkg("contents -r [email protected] [email protected]")

                self.pkg("contents -r [email protected] [email protected] [email protected] [email protected]")

                    self.foo_rurl))

                self.pkg("contents -r [email protected] [email protected] [email protected] [email protected]")

                self.pkg("contents -r [email protected] [email protected] [email protected] [email protected]")

                # Verify package installed from archive can be used with

                # contents.

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

                self.pkg("contents foo")

        def test_03_install_update(self):

                """Verify that install and update work as expected when

                compositing publishers.

                """

                #

                # Create an image and verify no packages are known.

                #

                self.image_create(self.empty_rurl, prefix=None)

                self.pkg("set-property signature-policy ignore")

                self.pkg("set-publisher --set-property signature-policy=ignore "

                    "test")

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

                # Verify that packages with dependencies can be installed when

                # using multiple, disparate sources.

                    self.signed_arc))

                self.pkg("install signed")

                self.pkg("list foo signed")

                self.pkg("uninstall \*")

                # Verify publisher can be removed.

                self.pkg("unset-publisher test")

                #

                # Create an image using the signed archive.

                #

                self.image_create(misc.parse_uri(self.signed_arc), prefix=None)

                self.__seed_ta_dir("ta1")

                # Verify that signed package can be installed and the archive

                # configured for the publisher allows dependencies to be

                # satisfied.

                self.pkg("set-property signature-policy verify")

                self.pkg("publisher test")

                self.pkg("install signed")

                self.pkg("list foo signed")

                # Verify that removing all packages and the signed archive as

                # a source leaves only foo known.

                self.pkg("uninstall \*")

                self.pkg("list -aH")

                expected = "foo 1.0 ---\n"

                output = self.reduceSpaces(self.output)

                self.assertEqualDiff(expected, output)

                #

                # Create an image and verify no packages are known.

                #

                self.image_create(self.empty_rurl, prefix=None)

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

                # Install an older version of a known package.

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

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

                # Verify that packages can be updated when using multiple,

                # disparate sources (that have some overlap).

                self.pkg("update")

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

                #

                # Create an image using the signed archive.

                #

                self.image_create(misc.parse_uri(self.signed_arc), prefix=None)

                self.__seed_ta_dir("ta1")

                # Add the incorp archive as a source.

                # Now verify that temporary package sources can be used during

                # package operations when multiple, disparate sources are

                # already configured for the same publisher.

                self.pkg("list incorp foo signed")

        def test_04_search(self):

                """Verify that search works as expected when compositing

                publishers.

                """

                #

                # Create an image and verify no packages are known.

                #

                self.image_create(self.empty_rurl, prefix=None)

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

                # Add multiple, different sources.

                    self.signed_rurl))

                # Verify a remote search that should only match one of the