##############################################################################

#

# Copyright (c) 2004-2009 Zope Corporation and Contributors.

# All Rights Reserved.

#

# This software is subject to the provisions of the Zope Public License,

# Version 2.0 (ZPL).  A copy of the ZPL should accompany this distribution.

# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED

# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS

# FOR A PARTICULAR PURPOSE.

#

##############################################################################

import doctest

from zope.testing import renormalizing

import os

import pkg_resources

import re

import shutil

import sys

import tempfile

import unittest

import zc.buildout.easy_install

import zc.buildout.testing

import zc.buildout.testselectingpython

import zipfile

os_path_sep = os.path.sep

if os_path_sep == '\\':

    os_path_sep *= 2

def develop_w_non_setuptools_setup_scripts():

    """

We should be able to deal with setup scripts that aren't setuptools based.

    >>> mkdir('foo')

    >>> write('foo', 'setup.py',

    ... '''

    ... from distutils.core import setup

    ... setup(name="foo")

    ... ''')

    >>> write('buildout.cfg',

    ... '''

    ... [buildout]

    ... develop = foo

    ... parts =

    ... ''')

    >>> print system(join('bin', 'buildout')),

    Develop: '/sample-buildout/foo'

    >>> ls('develop-eggs')

    -  foo.egg-link

    -  z3c.recipe.scripts.egg-link

    -  zc.recipe.egg.egg-link

    """

def develop_verbose():

    """

We should be able to deal with setup scripts that aren't setuptools based.

    >>> mkdir('foo')

    >>> write('foo', 'setup.py',

    ... '''

    ... from setuptools import setup

    ... setup(name="foo")

    ... ''')

    >>> write('buildout.cfg',

    ... '''

    ... [buildout]

    ... develop = foo

    ... parts =

    ... ''')

    >>> print system(join('bin', 'buildout')+' -vv'), # doctest: +ELLIPSIS

    Installing...

    Develop: '/sample-buildout/foo'

    ...

    Installed /sample-buildout/foo

    ...

    >>> ls('develop-eggs')

    -  foo.egg-link

    -  z3c.recipe.scripts.egg-link

    -  zc.recipe.egg.egg-link

    >>> print system(join('bin', 'buildout')+' -vvv'), # doctest: +ELLIPSIS

    Installing...

    Develop: '/sample-buildout/foo'

    in: '/sample-buildout/foo'

    ... -q develop -mxN -d /sample-buildout/develop-eggs/...

    """

def buildout_error_handling():

    r"""Buildout error handling

Asking for a section that doesn't exist, yields a missing section error:

    >>> import os

    >>> os.chdir(sample_buildout)

    >>> import zc.buildout.buildout

    >>> buildout = zc.buildout.buildout.Buildout('buildout.cfg', [])

    >>> buildout['eek']

    Traceback (most recent call last):

    ...

    MissingSection: The referenced section, 'eek', was not defined.

Asking for an option that doesn't exist, a MissingOption error is raised:

    >>> buildout['buildout']['eek']

    Traceback (most recent call last):

    ...

    MissingOption: Missing option: buildout:eek

It is an error to create a variable-reference cycle:

    >>> write(sample_buildout, 'buildout.cfg',

    ... '''

    ... [buildout]

    ... parts =

    ... x = ${buildout:y}

    ... y = ${buildout:z}

    ... z = ${buildout:x}

    ... ''')

    >>> print system(os.path.join(sample_buildout, 'bin', 'buildout')),

    ... # doctest: +NORMALIZE_WHITESPACE +ELLIPSIS

    While:

      Initializing.

      Getting section buildout.

      Initializing section buildout.

      Getting option buildout:y.

      Getting option buildout:z.

      Getting option buildout:x.

      Getting option buildout:y.

    Error: Circular reference in substitutions.

It is an error to use funny characters in variable refereces:

    >>> write(sample_buildout, 'buildout.cfg',

    ... '''

    ... [buildout]

    ... develop = recipes

    ... parts = data_dir debug

    ... x = ${bui$ldout:y}

    ... ''')

    >>> print system(os.path.join(sample_buildout, 'bin', 'buildout')),

    While:

      Initializing.

      Getting section buildout.

      Initializing section buildout.

      Getting option buildout:x.

    Error: The section name in substitution, ${bui$ldout:y},

    has invalid characters.

    >>> write(sample_buildout, 'buildout.cfg',

    ... '''

    ... [buildout]

    ... develop = recipes

    ... parts = data_dir debug

    ... x = ${buildout:y{z}

    ... ''')

    >>> print system(os.path.join(sample_buildout, 'bin', 'buildout')),

    While:

      Initializing.

      Getting section buildout.

      Initializing section buildout.

      Getting option buildout:x.

    Error: The option name in substitution, ${buildout:y{z},

    has invalid characters.

and too have too many or too few colons:

    >>> write(sample_buildout, 'buildout.cfg',

    ... '''

    ... [buildout]

    ... develop = recipes

    ... parts = data_dir debug

    ... x = ${parts}

    ... ''')

    >>> print system(os.path.join(sample_buildout, 'bin', 'buildout')),

    While:

      Initializing.

      Getting section buildout.

      Initializing section buildout.

      Getting option buildout:x.

    Error: The substitution, ${parts},

    doesn't contain a colon.

    >>> write(sample_buildout, 'buildout.cfg',

    ... '''

    ... [buildout]

    ... develop = recipes

    ... parts = data_dir debug

    ... x = ${buildout:y:z}

    ... ''')

    >>> print system(os.path.join(sample_buildout, 'bin', 'buildout')),

    While:

      Initializing.

      Getting section buildout.

      Initializing section buildout.

      Getting option buildout:x.

    Error: The substitution, ${buildout:y:z},

    has too many colons.

Al parts have to have a section:

    >>> write(sample_buildout, 'buildout.cfg',

    ... '''

    ... [buildout]

    ... parts = x

    ... ''')

    >>> print system(os.path.join(sample_buildout, 'bin', 'buildout')),

    While:

      Installing.

      Getting section x.

    Error: The referenced section, 'x', was not defined.

and all parts have to have a specified recipe:

    >>> write(sample_buildout, 'buildout.cfg',

    ... '''

    ... [buildout]

    ... parts = x

    ...

    ... [x]

    ... foo = 1

    ... ''')

    >>> print system(os.path.join(sample_buildout, 'bin', 'buildout')),

    While:

      Installing.

    Error: Missing option: x:recipe

"""

make_dist_that_requires_setup_py_template = """

from setuptools import setup

setup(name=%r, version=%r,

      install_requires=%r,

      )

"""

def make_dist_that_requires(dest, name, requires=[], version=1, egg=''):

    os.mkdir(os.path.join(dest, name))

    open(os.path.join(dest, name, 'setup.py'), 'w').write(

        make_dist_that_requires_setup_py_template

        % (name, version, requires)

        )

def show_who_requires_when_there_is_a_conflict():

    """

It's a pain when we require eggs that have requirements that are

incompatible. We want the error we get to tell us what is missing.

Let's make a few develop distros, some of which have incompatible

requirements.

    >>> make_dist_that_requires(sample_buildout, 'sampley',

    ...                         ['demoneeded ==1.0'])

    >>> make_dist_that_requires(sample_buildout, 'samplez',

    ...                         ['demoneeded ==1.1'])

Now, let's create a buildout that requires y and z:

    >>> write('buildout.cfg',

    ... '''

    ... [buildout]

    ... parts = eggs

    ... develop = sampley samplez

    ... find-links = %(link_server)s

    ...

    ... [eggs]

    ... recipe = zc.recipe.egg

    ... eggs = sampley

    ...        samplez

    ... ''' % globals())

    >>> print system(buildout),

    Develop: '/sample-buildout/sampley'

    Develop: '/sample-buildout/samplez'

    Installing eggs.

    Getting distribution for 'demoneeded==1.1'.

    Got demoneeded 1.1.

    While:

      Installing eggs.

    Error: There is a version conflict.

    We already have: demoneeded 1.1

    but sampley 1 requires 'demoneeded==1.0'.

Here, we see that sampley required an older version of demoneeded. What

if we hadn't required sampley ourselves:

    >>> make_dist_that_requires(sample_buildout, 'samplea', ['sampleb'])

    >>> make_dist_that_requires(sample_buildout, 'sampleb',

    ...                         ['sampley', 'samplea'])

    >>> write('buildout.cfg',

    ... '''

    ... [buildout]

    ... parts = eggs

    ... develop = sampley samplez samplea sampleb

    ... find-links = %(link_server)s

    ...

    ... [eggs]

    ... recipe = zc.recipe.egg

    ... eggs = samplea

    ...        samplez

    ... ''' % globals())

If we use the verbose switch, we can see where requirements are coming from:

    >>> print system(buildout+' -v'), # doctest: +ELLIPSIS

    Installing 'zc.buildout', 'setuptools'.

    We have a develop egg: zc.buildout 1.0.0

    We have the best distribution that satisfies 'setuptools'.

    Picked: setuptools = 0.6

    Develop: '/sample-buildout/sampley'

    Develop: '/sample-buildout/samplez'

    Develop: '/sample-buildout/samplea'

    Develop: '/sample-buildout/sampleb'

    ...Installing eggs.

    Installing 'samplea', 'samplez'.

    We have a develop egg: samplea 1

    We have a develop egg: samplez 1

    Getting required 'demoneeded==1.1'

      required by samplez 1.

    We have the distribution that satisfies 'demoneeded==1.1'.

    Getting required 'sampleb'

      required by samplea 1.

    We have a develop egg: sampleb 1

    Getting required 'sampley'

      required by sampleb 1.

    We have a develop egg: sampley 1

    While:

      Installing eggs.

    Error: There is a version conflict.

    We already have: demoneeded 1.1

    but sampley 1 requires 'demoneeded==1.0'.

    """

def show_who_requires_missing_distributions():

    """

When working with a lot of eggs, which require eggs recursively, it can

be hard to tell why we're requiring things we can't find. Fortunately,

buildout will tell us who's asking for something that we can't find.

    >>> make_dist_that_requires(sample_buildout, 'sampley', ['demoneeded'])

    >>> make_dist_that_requires(sample_buildout, 'samplea', ['sampleb'])

    >>> make_dist_that_requires(sample_buildout, 'sampleb',

    ...                         ['sampley', 'samplea'])

    >>> write('buildout.cfg',

    ... '''

    ... [buildout]

    ... parts = eggs

    ... develop = sampley samplea sampleb

    ...

    ... [eggs]

    ... recipe = zc.recipe.egg

    ... eggs = samplea

    ... ''')

    >>> print system(buildout),

    Develop: '/sample-buildout/sampley'

    Develop: '/sample-buildout/samplea'

    Develop: '/sample-buildout/sampleb'

    Installing eggs.

    Couldn't find index page for 'demoneeded' (maybe misspelled?)

    Getting distribution for 'demoneeded'.

    While:

      Installing eggs.

      Getting distribution for 'demoneeded'.

    Error: Couldn't find a distribution for 'demoneeded'.

    """

def show_eggs_from_site_packages():

    """

Sometimes you want to know what eggs are coming from site-packages.  This

might be for a diagnostic, or so that you can get a starting value for the

allowed-eggs-from-site-packages option.  The -v flag will also include this

information.

Our "py_path" has the "demoneeded," "demo"

packages available.  We'll ask for "bigdemo," which will get both of them.

Here's our set up.

    >>> py_path, site_packages_path = make_py()

    >>> create_sample_sys_install(site_packages_path)

    >>> write('buildout.cfg',

    ... '''

    ... [buildout]

    ... parts = eggs

    ... prefer-final = true

    ... find-links = %(link_server)s

    ...

    ... [primed_python]

    ... executable = %(py_path)s

    ...

    ... [eggs]

    ... recipe = zc.recipe.egg:eggs

    ... python = primed_python

    ... eggs = bigdemo

    ... ''' % globals())

Now here is the output.  The lines that begin with "Egg from site-packages:"

indicate the eggs from site-packages that have been selected.  You'll see

we have two: demo 0.3 and demoneeded 1.1.

    >>> print system(buildout+" -v"),

    Installing 'zc.buildout', 'setuptools'.

    We have a develop egg: zc.buildout V

    We have the best distribution that satisfies 'setuptools'.

    Picked: setuptools = V

    Installing 'zc.recipe.egg'.

    We have a develop egg: zc.recipe.egg V

    Installing eggs.

    Installing 'bigdemo'.

    We have no distributions for bigdemo that satisfies 'bigdemo'.

    Getting distribution for 'bigdemo'.

    Got bigdemo 0.1.

    Picked: bigdemo = 0.1

    Getting required 'demo'

      required by bigdemo 0.1.

    We have the best distribution that satisfies 'demo'.

    Egg from site-packages: demo 0.3

    Getting required 'demoneeded'

      required by demo 0.3.

    We have the best distribution that satisfies 'demoneeded'.

    Egg from site-packages: demoneeded 1.1

    """

def test_comparing_saved_options_with_funny_characters():

    """

If an option has newlines, extra/odd spaces or a %, we need to make sure

the comparison with the saved value works correctly.

    >>> mkdir(sample_buildout, 'recipes')

    >>> write(sample_buildout, 'recipes', 'debug.py',

    ... '''

    ... class Debug:

    ...     def __init__(self, buildout, name, options):

    ...         options['debug'] = \"\"\"  <zodb>

    ...

    ...   <filestorage>

    ...     path foo

    ...   </filestorage>

    ...

    ... </zodb>

    ...      \"\"\"

    ...         options['debug1'] = \"\"\"

    ... <zodb>

    ...

    ...   <filestorage>

    ...     path foo

    ...   </filestorage>

    ...

    ... </zodb>

    ... \"\"\"

    ...         options['debug2'] = '  x  '

    ...         options['debug3'] = '42'

    ...         options['format'] = '%3d'

    ...

    ...     def install(self):

    ...         open('t', 'w').write('t')

    ...         return 't'

    ...

    ...     update = install

    ... ''')

    >>> write(sample_buildout, 'recipes', 'setup.py',

    ... '''

    ... from setuptools import setup

    ... setup(

    ...     name = "recipes",

    ...     entry_points = {'zc.buildout': ['default = debug:Debug']},

    ...     )

    ... ''')

    >>> write(sample_buildout, 'recipes', 'README.txt', " ")

    >>> write(sample_buildout, 'buildout.cfg',

    ... '''

    ... [buildout]

    ... develop = recipes

    ... parts = debug

    ...

    ... [debug]

    ... recipe = recipes

    ... ''')

    >>> os.chdir(sample_buildout)

    >>> buildout = os.path.join(sample_buildout, 'bin', 'buildout')

    >>> print system(buildout),

    Develop: '/sample-buildout/recipes'

    Installing debug.

If we run the buildout again, we shoudn't get a message about

uninstalling anything because the configuration hasn't changed.

    >>> print system(buildout),

    Develop: '/sample-buildout/recipes'

    Updating debug.

"""

def finding_eggs_as_local_directories():

    r"""

It is possible to set up find-links so that we could install from

a local directory that may contained unzipped eggs.

    >>> src = tmpdir('src')

    >>> write(src, 'setup.py',

    ... '''

    ... from setuptools import setup