LINK_METADATA = frozenset([

    'approval',

    'check',

    'contract',

    'invoice',

    'purchase-order',

    'receipt',

    'rt-id',

    'statement',

])

class Account(str):

    """Account name string

    This is a string that names an account, like Assets:Bank:Checking

    or Income:Donations. This class provides additional methods for common

    account name parsing and queries.

    """

    __slots__ = ()

    SEP = bc_account.sep

    def is_cash_equivalent(self) -> bool:

        return (

            self.is_under('Assets:') is not None

            and self.is_under('Assets:Prepaid', 'Assets:Receivable') is None

        )

    def is_checking(self) -> bool:

        return self.is_cash_equivalent() and ':Check' in self

    def is_credit_card(self) -> bool:

        return self.is_under('Liabilities:CreditCard') is not None

    def is_opening_equity(self) -> bool:

        return self.is_under('Equity:Funds', 'Equity:OpeningBalance') is not None

    def is_under(self, *acct_seq: str) -> Optional[str]:

        """Return a match if this account is "under" a part of the hierarchy

        Pass in any number of account name strings as arguments. If this

        account is under one of those strings in the account hierarchy, the

        first matching string will be returned. Otherwise, None is returned.

        You can use the return value of this method as a boolean if you don't

        care which account string is matched.

        An account is considered to be under itself:

          Account('Expenses:Tax').is_under('Expenses:Tax') # returns 'Expenses:Tax'

        To do a "strictly under" search, end your search strings with colons:

          Account('Expenses:Tax').is_under('Expenses:Tax:') # returns None

          Account('Expenses:Tax').is_under('Expenses:') # returns 'Expenses:'

        This method does check that all the account boundaries match:

          Account('Expenses:Tax').is_under('Exp') # returns None

        """

        for prefix in acct_seq:

            if self.startswith(prefix) and (

                prefix.endswith(self.SEP)

                or self == prefix

                or self[len(prefix)] == self.SEP

            ):

                return prefix

        return None

    def _find_part_slice(self, index: int) -> slice:

        if index < 0:

            raise ValueError(f"bad part index {index!r}")

        start = 0

        for _ in range(index):

            try:

                start = self.index(self.SEP, start) + 1

            except ValueError:

                raise IndexError("part index {index!r} out of range") from None

        try:

            stop = self.index(self.SEP, start + 1)

        except ValueError:

            stop = len(self)

        return slice(start, stop)

    def count_parts(self) -> int:

        return self.count(self.SEP) + 1

    @overload

    def slice_parts(self, start: None=None, stop: None=None) -> Sequence[str]: ...

    @overload

    def slice_parts(self, start: slice, stop: None=None) -> Sequence[str]: ...

    @overload

    def slice_parts(self, start: int, stop: int) -> Sequence[str]: ...

    @overload

    def slice_parts(self, start: int, stop: None=None) -> str: ...

    def slice_parts(self,

                    start: Optional[Union[int, slice]]=None,

                    stop: Optional[int]=None,

    ) -> Sequence[str]:

        """Slice the account parts like they were a list

        Given a single index, return that part of the account name as a string.

        Otherwise, return a list of part names sliced according to the arguments.

        """

        if start is None:

            part_slice = slice(None)

        elif isinstance(start, slice):

            part_slice = start

        elif stop is None:

            return self[self._find_part_slice(start)]

        else:

            part_slice = slice(start, stop)

        return self.split(self.SEP)[part_slice]

    def root_part(self, count: int=1) -> str:

        """Return the first part(s) of the account name as a string"""

        try:

            stop = self._find_part_slice(count - 1).stop

        except IndexError:

            return self

        else:

            return self[:stop]

class Amount(bc_amount.Amount):

    """Beancount amount after processing

    Beancount's native Amount class declares number to be Optional[Decimal],

    because the number is None when Beancount first parses a posting that does

    not have an amount, because the user wants it to be automatically balanced.

    As part of the loading process, Beancount replaces those None numbers

    with the calculated amount, so it will always be a Decimal. This class

    overrides the type declaration accordingly, so the type checker knows

    that our code doesn't have to consider the possibility that number is

    None.

    """

    number: decimal.Decimal

    # beancount.core._Amount is the plain namedtuple.

    # beancore.core.Amount adds instance methods to it.

    # b.c.Amount.__New__ calls `b.c._Amount.__new__`, which confuses type

    # checking. See <https://github.com/python/mypy/issues/1279>.

    # It works fine if you use super(), which is better practice anyway.

    # So we override __new__ just to call _Amount.__new__ this way.

    def __new__(cls, number: decimal.Decimal, currency: str) -> 'Amount':

        return super(bc_amount.Amount, Amount).__new__(cls, number, currency)

class Metadata(MutableMapping[MetaKey, MetaValue]):

    """Transaction or posting metadata

    This class wraps a Beancount metadata dictionary with additional methods

    for common parsing and query tasks.

    """

    __slots__ = ('meta',)

    def __init__(self, source: MutableMapping[MetaKey, MetaValue]) -> None:

        self.meta = source

    def __iter__(self) -> Iterator[MetaKey]:

        return iter(self.meta)

    def __len__(self) -> int:

        return len(self.meta)

    def __getitem__(self, key: MetaKey) -> MetaValue:

        return self.meta[key]

    def __setitem__(self, key: MetaKey, value: MetaValue) -> None:

        self.meta[key] = value

    def __delitem__(self, key: MetaKey) -> None:

        del self.meta[key]

    def get_links(self, key: MetaKey) -> Sequence[str]:

        try:

            value = self.meta[key]

        except KeyError:

            return ()

        if isinstance(value, str):

            return value.split()

        else:

            raise TypeError("{} metadata is a {}, not str".format(

                key, type(value).__name__,

            ))

class PostingMeta(Metadata):

    """Combined access to posting metadata with its parent transaction metadata

    This lets you access posting metadata through a single dict-like object.

    If you try to look up metadata that doesn't exist on the posting, it will

    look for the value in the parent transaction metadata instead.

    You can set and delete metadata as well. Changes only affect the metadata

    of the posting, never the transaction. Changes are propagated to the

    underlying Beancount data structures.

    Functionally, you can think of this as identical to:

      collections.ChainMap(post.meta, txn.meta)

    Under the hood, this class does a little extra work to avoid creating

    posting metadata if it doesn't have to.

    """

    __slots__ = ('txn', 'index', 'post')

    def __init__(self,

                 txn: Transaction,

                 index: int,

                 post: Optional[BasePosting]=None,

    ) -> None:

        if post is None:

            post = txn.postings[index]

        self.txn = txn

        self.index = index

        self.post = post

        if post.meta is None:

            self.meta = self.txn.meta

        else:

            self.meta = collections.ChainMap(post.meta, txn.meta)

    def __getitem__(self, key: MetaKey) -> MetaValue:

        try:

            return super().__getitem__(key)

        except KeyError:

            if key == 'entity' and self.txn.payee is not None:

                return self.txn.payee

            else:

                raise

    def __setitem__(self, key: MetaKey, value: MetaValue) -> None:

        if self.post.meta is None:

            self.post = self.post._replace(meta={key: value})

            self.txn.postings[self.index] = self.post

            # mypy complains that self.post.meta could be None, but we know

            # from two lines up that it's not.

            self.meta = collections.ChainMap(self.post.meta, self.txn.meta)  # type:ignore[arg-type]

        else:

            super().__setitem__(key, value)

    def __delitem__(self, key: MetaKey) -> None:

        if self.post.meta is None:

            raise KeyError(key)

        else:

            super().__delitem__(key)

    # This is arguably cheating a litttle bit, but I'd argue the date of

    # the parent transaction still qualifies as posting metadata, and

    # it's something we want to access so often it's good to have it

    # within easy reach.

    @property

    def date(self) -> datetime.date:

        return self.txn.date

class Posting(BasePosting):

    """Enhanced Posting objects

    This class is a subclass of Beancount's native Posting class where

    specific fields are replaced with enhanced versions:

    * The `account` field is an Account object

    * The `units` field is our Amount object (which simply declares that the

      number is always a Decimal—see that docstring for details)

    * The `meta` field is a PostingMeta object

    """

    __slots__ = ()

    account: Account

    units: Amount

    cost: Optional[bc_position.Cost]

    # mypy correctly complains that our MutableMapping is not compatible

    # with Beancount's meta type declaration of Optional[Dict]. IMO

    # Beancount's type declaration is a smidge too specific: I think its type

    # declaration should also use MutableMapping, because it would be very

    # unusual for code to specifically require a Dict over that.

    # If it did, this declaration would pass without issue.

    meta: PostingMeta  # type:ignore[assignment]

    @classmethod

    def from_beancount(cls,

                       txn: Transaction,

                       index: int,

                       post: Optional[BasePosting]=None,

    ) -> 'Posting':

        if post is None:

            post = txn.postings[index]

        return cls(

            Account(post.account),

            *post[1:5],

            # see rationale above about Posting.meta

            PostingMeta(txn, index, post), # type:ignore[arg-type]

        )

    @classmethod

    def from_txn(cls, txn: Transaction) -> Iterator['Posting']:

        """Yield an enhanced Posting object for every posting in the transaction"""

        for index, post in enumerate(txn.postings):

            yield cls.from_beancount(txn, index, post)

    @classmethod

    def from_entries(cls, entries: Iterable[Directive]) -> Iterator['Posting']:

        """Yield an enhanced Posting object for every posting in these entries"""

        for entry in entries:

            # Because Beancount's own Transaction class isn't type-checkable,

            # we can't statically check this. Might as well rely on duck

            # typing while we're at it: just try to yield postings from

            # everything, and ignore entries that lack a postings attribute.

            try:

                yield from cls.from_txn(entry)  # type:ignore[arg-type]

            except AttributeError:

                pass

_KT = TypeVar('_KT', bound=Hashable)

_VT = TypeVar('_VT')

class _SizedDict(collections.OrderedDict, MutableMapping[_KT, _VT]):

    def __init__(self, maxsize: int=128) -> None:

        self.maxsize = maxsize

        super().__init__()

    def __setitem__(self, key: _KT, value: _VT) -> None:

        super().__setitem__(key, value)

        for _ in range(self.maxsize, len(self)):

            self.popitem(last=False)

def balance_of(txn: Transaction,

               *preds: Callable[[Account], Optional[bool]],

) -> Amount:

    """Return the balance of specified postings in a transaction.

    Given a transaction and a series of account predicates, balance_of

    returns the balance of the amounts of all postings with accounts that

    match any of the predicates.

    balance_of uses the "weight" of each posting, so the return value will

    use the currency of the postings' cost when available.

    """

    match_posts = [post for post in Posting.from_txn(txn)

                   if any(pred(post.account) for pred in preds)]

    number = decimal.Decimal(0)

    if not match_posts:

        currency = ''

    else:

        weights: Sequence[Amount] = [

            bc_convert.get_weight(post) for post in match_posts

        ]

        number = sum((wt.number for wt in weights), number)

        currency = weights[0].currency

    return Amount(number, currency)

_opening_balance_cache: MutableMapping[str, bool] = _SizedDict()

def is_opening_balance_txn(txn: Transaction) -> bool:

    key = '\0'.join(

        f'{post.account}={post.units}' for post in txn.postings

    )

    try:

        return _opening_balance_cache[key]

    except KeyError:

        pass

    opening_equity = balance_of(txn, Account.is_opening_equity)

    if not opening_equity.currency:

        retval = False

    else:

        rest = balance_of(txn, lambda acct: not acct.is_opening_equity())

        if not rest.currency:

            retval = False

        else:

            retval = abs(opening_equity.number + rest.number) < decimal.Decimal('.01')

    _opening_balance_cache[key] = retval

    return retval

    accrual-report --since -3 [search terms …]

If you want to further limit what accruals are reported, you can match on

other metadata by passing additional arguments in ``name=value`` format.

You can pass any number of search terms. For example::

    # Report accruals associated with RT#1230 and Jane Doe

    accrual-report 1230 entity=Doe-Jane

accrual-report will automatically decide what kind of report to generate

from the search terms you provide and the results they return. If you pass

no search terms, it generates an aging report. If your search terms match a

single outstanding payable, it writes an outgoing approval report.

Otherwise, it writes a basic balance report. You can specify what report

type you want with the ``--report-type`` option::

    # Write an outgoing approval report for all outstanding accruals for

    # Jane Doe, even if there's more than one

    accrual-report --report-type outgoing entity=Doe-Jane

    # Write an aging report for a specific project

    accrual-report --report-type aging project=ProjectName

"""

# Copyright © 2020  Brett Smith

#

# This program is free software: you can redistribute it and/or modify

# it under the terms of the GNU Affero 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 Affero General Public License for more details.

#

# You should have received a copy of the GNU Affero General Public License

# along with this program.  If not, see <https://www.gnu.org/licenses/>.

import argparse

import collections

import datetime

import enum

import logging

import re

import sys

import urllib.parse as urlparse

from pathlib import Path

from typing import (

    cast,

    Any,

    BinaryIO,

    Callable,

    Iterable,

    Iterator,

    List,

    Mapping,

    NamedTuple,

    Optional,

    Sequence,

    Set,

    TextIO,

    Tuple,

    TypeVar,

    Union,

)

from ..beancount_types import (

    Entries,

    Error,

    Errors,

    MetaKey,

    MetaValue,

    Transaction,

)

import odf.style  # type:ignore[import]

import odf.table  # type:ignore[import]

import rt

from beancount.parser import printer as bc_printer

from . import core

from .. import books

from .. import cliutil

from .. import config as configmod

from .. import data

from .. import filters

from .. import rtutil

PROGNAME = 'accrual-report'

CompoundAmount = TypeVar('CompoundAmount', data.Amount, core.Balance)

PostGroups = Mapping[Optional[MetaValue], 'AccrualPostings']

RTObject = Mapping[str, str]

T = TypeVar('T')

logger = logging.getLogger('conservancy_beancount.reports.accrual')

class Sentinel:

    pass

class Account(NamedTuple):

    name: str

    aging_thresholds: Sequence[int]

class AccrualAccount(enum.Enum):

    # Note the aging report uses the same order accounts are defined here.

    # See AgingODS.start_spreadsheet().

    RECEIVABLE = Account('Assets:Receivable', [365, 120, 90, 60])

    PAYABLE = Account('Liabilities:Payable', [365, 90, 60, 30])

    @classmethod

    def account_names(cls) -> Iterator[str]:

        return (acct.value.name for acct in cls)

    @classmethod

    def by_account(cls, name: data.Account) -> 'AccrualAccount':

        for account in cls:

            if name.is_under(account.value.name):

                return account

        raise ValueError(f"unrecognized account {name!r}")

    @classmethod

    def classify(cls, related: core.RelatedPostings) -> 'AccrualAccount':

        for account in cls:

            account_name = account.value.name

            if all(post.account.is_under(account_name) for post in related):

                return account

        raise ValueError("unrecognized account set in related postings")

    @property

    def normalize_amount(self) -> Callable[[T], T]:

        return core.normalize_amount_func(self.value.name)

class AccrualPostings(core.RelatedPostings):

    __slots__ = (

        'accrual_type',

        'end_balance',

        'account',

        'entity',

        'invoice',

    )

    INCONSISTENT = Sentinel()

    def __init__(self,

                 source: Iterable[data.Posting]=(),

                 *,

                 _can_own: bool=False,

    ) -> None:

        super().__init__(source, _can_own=_can_own)

        # The following type declarations tell mypy about values set in the for

        # loop that are important enough to be referenced directly elsewhere.

        self.account = self._single_item(post.account for post in self)

        if isinstance(self.account, Sentinel):

            self.accrual_type: Optional[AccrualAccount] = None

            norm_func: Callable[[T], T] = lambda x: x

            entity_pred: Callable[[data.Posting], bool] = bool

        else:

            self.accrual_type = AccrualAccount.by_account(self.account)

            norm_func = self.accrual_type.normalize_amount

            entity_pred = lambda post: norm_func(post.units).number > 0

        self.entity = self._single_item(self.entities(entity_pred))

        self.invoice = self._single_item(self.first_links('invoice'))

        self.end_balance = norm_func(self.balance_at_cost())

    def _single_item(self, seq: Iterable[T]) -> Union[T, Sentinel]:

        items = iter(seq)

        try:

            item1 = next(items)

        except StopIteration:

            all_same = False

        else:

            all_same = all(item == item1 for item in items)

        return item1 if all_same else self.INCONSISTENT

    def entities(self, pred: Callable[[data.Posting], bool]=bool) -> Iterator[MetaValue]:

        seen: Set[MetaValue] = set()

        for post in self:

            if pred(post):

                try:

                    entity = post.meta['entity']

                except KeyError:

                    pass

                else:

                    if entity not in seen:

                        yield entity

                        seen.add(entity)

    def first_links(self, key: MetaKey, default: Optional[str]=None) -> Iterator[Optional[str]]:

    def make_consistent(self) -> Iterator[Tuple[MetaValue, 'AccrualPostings']]:

        account_ok = isinstance(self.account, str)

        entity_ok = isinstance(self.entity, str)

        # `'/' in self.invoice` is just our heuristic to ensure that the

        # invoice metadata is "unique enough," and not just a placeholder

        # value like "FIXME". It can be refined if needed.

        invoice_ok = isinstance(self.invoice, str) and '/' in self.invoice

        if account_ok and entity_ok and invoice_ok:

            yield (self.invoice, self)

            return

        groups = collections.defaultdict(list)

        for post in self:

            post_invoice = self.invoice if invoice_ok else (

                post.meta.get('invoice') or 'BlankInvoice'

            )

            post_entity = self.entity if entity_ok else (

                post.meta.get('entity') or 'BlankEntity'

            )

            groups[f'{post.account} {post_invoice} {post_entity}'].append(post)

        type_self = type(self)

        for group_key, posts in groups.items():

            yield group_key, type_self(posts, _can_own=True)

    def is_paid(self, default: Optional[bool]=None) -> Optional[bool]:

        if self.accrual_type is None:

            return default

        else:

            return self.end_balance.le_zero()

    def is_zero(self, default: Optional[bool]=None) -> Optional[bool]:

        if self.accrual_type is None:

            return default

        else:

            return self.end_balance.is_zero()

    def since_last_nonzero(self) -> 'AccrualPostings':

        for index, (post, balance) in enumerate(self.iter_with_balance()):

            if balance.is_zero():

                start_index = index

        try:

            empty = start_index == index

        except NameError:

            empty = True

        return self if empty else self[start_index + 1:]

class BaseReport:

    def __init__(self, out_file: TextIO) -> None:

        self.out_file = out_file

        self.logger = logger.getChild(type(self).__name__)

    def _report(self, posts: AccrualPostings, index: int) -> Iterable[str]:

        raise NotImplementedError("BaseReport._report")

    def run(self, groups: PostGroups) -> None:

        for index, invoice in enumerate(groups):

            for line in self._report(groups[invoice], index):

                print(line, file=self.out_file)

class AgingODS(core.BaseODS[AccrualPostings, Optional[data.Account]]):

    COLUMNS = [

        'Date',

        'Entity',

        'Invoice Amount',

        'Booked Amount',

        'Project',

        'Ticket',

        'Invoice',

        'Approval',

        'Contract',

        'Purchase Order',

    ]

    COL_COUNT = len(COLUMNS)

    def __init__(self,

                 rt_client: rt.Rt,

                 date: datetime.date,

                 logger: logging.Logger,

    ) -> None:

        super().__init__()

        self.rt_client = rt_client

        self.rt_wrapper = rtutil.RT(self.rt_client)

        self.date = date

        self.logger = logger

    def init_styles(self) -> None:

        super().init_styles()

        self.style_widecol = self.replace_child(

            self.document.automaticstyles,

            odf.style.Style,

            name='WideCol',

        )

        self.style_widecol.setAttribute('family', 'table-column')

        self.style_widecol.addElement(odf.style.TableColumnProperties(

            columnwidth='1.25in',

        ))

    def section_key(self, row: AccrualPostings) -> Optional[data.Account]:

        if isinstance(row.account, str):

            return row.account

        else:

            return None

    def start_spreadsheet(self) -> None:

        for accrual_type in AccrualAccount:

            self.use_sheet(accrual_type.name.title())

            for index in range(self.COL_COUNT):

                stylename = self.style_widecol if index else ''

                self.sheet.addElement(odf.table.TableColumn(stylename=stylename))

            self.add_row(*(

                self.string_cell(name, stylename=self.style_bold)

                for name in self.COLUMNS

            ))

            self.lock_first_row()

    def start_section(self, key: Optional[data.Account]) -> None:

        if key is None:

            return

        self.age_thresholds = list(AccrualAccount.by_account(key).value.aging_thresholds)

        self.age_balances = [core.MutableBalance() for _ in self.age_thresholds]

        accrual_date = self.date - datetime.timedelta(days=self.age_thresholds[-1])

        acct_parts = key.slice_parts()

        self.use_sheet(acct_parts[1])

        self.add_row()

        self.add_row(self.string_cell(

            f"{' '.join(acct_parts[2:])} {acct_parts[1]} Aging Report"

            f" Accrued by {accrual_date.isoformat()} Unpaid by {self.date.isoformat()}",

            stylename=self.merge_styles(self.style_bold, self.style_centertext),

            numbercolumnsspanned=self.COL_COUNT,

        ))

        self.add_row()

    def end_section(self, key: Optional[data.Account]) -> None:

        if key is None:

            return

        total_balance = core.MutableBalance()

        text_style = self.merge_styles(self.style_bold, self.style_endtext)

        text_span = 4

        last_age_text: Optional[str] = None

        self.add_row()

        for threshold, balance in zip(self.age_thresholds, self.age_balances):

            years, days = divmod(threshold, 365)

            years_text = f"{years} {'Year' if years == 1 else 'Years'}"

            days_text = f"{days} Days"

            if years and days:

                age_text = f"{years_text} {days_text}"

            elif years:

                age_text = years_text

            else:

                age_text = days_text

            if last_age_text is None:

                age_range = f"Over {age_text}"

            else:

                age_range = f"{age_text}–{last_age_text}"

            self.add_row(

                self.string_cell(

                    f"Total Aged {age_range}: ",

                    stylename=text_style,

                    numbercolumnsspanned=text_span,

                ),

                *(odf.table.TableCell() for _ in range(1, text_span)),

                self.balance_cell(balance),

            )

            last_age_text = age_text

            total_balance += balance

        self.add_row(

            self.string_cell(

                "Total Unpaid: ",

                stylename=text_style,

                numbercolumnsspanned=text_span,

            ),

            *(odf.table.TableCell() for _ in range(1, text_span)),

            self.balance_cell(total_balance),

        )

    def _link_seq(self, row: AccrualPostings, key: MetaKey) -> Iterator[Tuple[str, str]]:

        for href in row.all_meta_links(key):

            text: Optional[str] = None

            rt_ids = self.rt_wrapper.parse(href)

            if rt_ids is not None:

                ticket_id, attachment_id = rt_ids

                if attachment_id is None:

                    text = f'RT#{ticket_id}'

                href = self.rt_wrapper.url(ticket_id, attachment_id) or href

            else:

                # '..' pops the ODS filename off the link path. In other words,

                # make the link relative to the directory the ODS is in.

                href = f'../{href}'

            if text is None:

                href_path = Path(urlparse.urlparse(href).path)

"""Test Metadata class"""

# Copyright © 2020  Brett Smith

#

# This program is free software: you can redistribute it and/or modify

# it under the terms of the GNU Affero 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 Affero General Public License for more details.

#

# You should have received a copy of the GNU Affero General Public License

# along with this program.  If not, see <https://www.gnu.org/licenses/>.

import pytest

from . import testutil

from conservancy_beancount import data

@pytest.fixture

def simple_txn(index=None, key=None):

    return testutil.Transaction(note='txn note', postings=[

        ('Assets:Cash', 5),

        ('Income:Donations', -5, {'note': 'donation love', 'extra': 'Extra'}),

    ])

SIMPLE_TXN_METAKEYS = frozenset(['filename', 'lineno', 'note'])

def test_metadata_transforms_source():

    source = {'1': 'one'}

    meta = data.Metadata(source)

    meta['2'] = 'two'

    assert source['2'] == 'two'

    del meta['1']

    assert set(source) == {'2'}

@pytest.mark.parametrize('value', [

    '',

    'link',

    '  link',

    'link  ',

    'link1  link2',

    ' link1  link2   link3    ',

])

def test_get_links(value):

    meta = data.Metadata({'key': value})

    assert list(meta.get_links('key')) == value.split()

def test_get_links_missing():

    meta = data.Metadata({})

    assert not meta.get_links('key')

@pytest.mark.parametrize('value', testutil.NON_STRING_METADATA_VALUES)

def test_get_links_bad_type(value):

    meta = data.Metadata({'key': value})

    with pytest.raises(TypeError):

        meta.get_links('key')