PK njM contactList/VERSION0.1.0
PK ljMK; contactList/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""A Python 3 framework for constructing, managing and organising email addresses in YAML format.
"""
import os
here = os.path.dirname( __file__ )
with open( os.path.join( here, 'VERSION' ) ) as versionFile :
version = versionFile.read()
__version__ = version.strip()
from contactList.contacts.contact import ContactData
PK ljM e contactList/entry.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Define contact management entrypoint.
"""
import sys
from .arguments import ContactsOptions
from .contacts import Contacts
def main( commandLineArguments ) :
debugMode = False
try :
managerOptions = ContactsOptions.from_arguments( commandLineArguments )
debugMode = managerOptions.debug
contacts = Contacts.from_yamlFile( filename = managerOptions.contactsFile )
contacts.applyAction( managerOptions )
contacts.to_yamlFile( filename = managerOptions.contactsFile )
except Exception as e :
if not debugMode :
print( str( e ), file = sys.stderr )
# Exit with non-zero status (dirty).
sys.exit( 1 )
else :
raise
def entryPoint() :
"""
Flit entrypoint. The flit entrypoint must not have any arguments, so here it just calls ``main`` with
``sys.argv`` argument.
"""
main( sys.argv[ 1 : ] )
if __name__ == '__main__' :
main( sys.argv[ 1 : ] )
PK ljM ! contactList/arguments/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Command line argument parsing implementation.
"""
from .top import ContactsOptions
PK ljMI0 contactList/arguments/top.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Top level command line argument parsing configuration.
"""
from .base import BadArgument, CommandTree
from .cluster import CLUSTER_SUBCOMMAND_GRAPH
from .email import EMAIL_SUBCOMMAND_GRAPH
from .group import GROUP_SUBCOMMAND_GRAPH
class ContactsOptions :
"""
Top level command line argument parsing configuration.
"""
__DEFAULT_FILE = 'contacts.yml'
__CONTACTSFILE_ARGUMENT_GRAPH = {
'names' : [ '--file', '-f', ],
'options' : {
'default' : __DEFAULT_FILE,
'dest' : 'contactsFile',
'help' : 'Contacts file to manage (default ''{0}'')'.format( __DEFAULT_FILE ),
'type' : str
}
}
__DEBUG_ARGUMENT_GRAPH = {
'names' : [ '--debug', '-d', ],
'options' : {
'action' : 'store_true',
'help' : 'Enable exception stack trace reporting to command line',
}
}
__CONTACTS_COMMAND_GRAPH = {
'arguments' : [
__CONTACTSFILE_ARGUMENT_GRAPH,
__DEBUG_ARGUMENT_GRAPH,
],
'options' : {
'dest' : 'activeSubcommand',
},
'subcommands' : [
CLUSTER_SUBCOMMAND_GRAPH,
EMAIL_SUBCOMMAND_GRAPH,
GROUP_SUBCOMMAND_GRAPH,
],
}
def __init__( self ) :
self.__commandTree = CommandTree( specification = self.__CONTACTS_COMMAND_GRAPH )
self.__parsedArguments = None
def parse( self, commandLineArguments: list ) :
"""
Parse command line arguments.
:param commandLineArguments:
:return:
"""
self.__parsedArguments = self.__commandTree.parse( commandLineArguments )
if not self.__parsedArguments.activeSubcommand :
raise BadArgument( 'Must specify a contact list operation' )
def __getattr__( self, item ) :
"""
From parsed arguments, recover the items from an `argparse.Namespace` object.
:param item: parsed argument item name.
:return: Parsed argument item.
"""
return getattr( self.__parsedArguments, item )
@classmethod
def from_arguments( cls, commandLineArguments: list ) :
options = cls()
options.parse( commandLineArguments )
return options
PK ljMi^Y Y & contactList/arguments/base/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Base definitions for command line parsing.
"""
from .abstract import Subcommand
from .exception import BadArgument
from .tree import CommandTree
PK ljMy[ [ & contactList/arguments/base/abstract.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Subcommand command line parsing.
"""
import abc
class Subcommand( metaclass = abc.ABCMeta ) :
"""
Abstract interface for subcommand parsing.
"""
def __init__( self, parentNode = None ) :
self.parent = parentNode
@abc.abstractmethod
def addSubcommand( self, *args, **kwargs ) :
pass
@abc.abstractmethod
def assign( self, arguments ) :
pass
PK ljM *9c c ' contactList/arguments/base/exception.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Command line argument exceptions.
"""
class BadArgument( Exception ) :
"""
Exception for errors in command line argument parsing.
"""
pass
PK ljM=
=
" contactList/arguments/base/tree.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Command tree construction.
"""
import argparse
import logging
log = logging.getLogger( __name__ )
class CommandTreeNode :
"""
Construct a command tree node (command) from a specification dictionary.
"""
def __init__( self, name, parser,
specification = None ) :
self.specification = specification
self.name = name
self.parser = parser
self.subparsers = None
self.subcommands = list()
self.__addArguments()
self.__addSubcommands()
def __addArguments( self ) :
"""
Add arguments to the parser.
"""
if 'arguments' in self.specification :
for thisArgument in self.specification[ 'arguments' ] :
log.debug( 'Adding argument, {0}'.format( thisArgument[ 'names' ][ 0 ] ) )
self.parser.add_argument( *thisArgument[ 'names' ], **thisArgument[ 'options' ] )
def __addSubcommands( self ) :
"""
Add sub-commands to the parser.
"""
if 'subcommands' in self.specification :
if self.specification[ 'subcommands' ] :
if 'options' in self.specification :
self.subparsers = self.parser.add_subparsers( **self.specification[ 'options' ] )
else :
self.subparsers = self.parser.add_subparsers()
for thisSubcommand in self.specification[ 'subcommands' ] :
thisName = thisSubcommand[ 'names' ][ 0 ]
thisSpecification = thisSubcommand[ 'specification' ]
thisAliases = list()
if len( thisSubcommand[ 'names' ] ) > 1 :
thisAliases = thisSubcommand[ 'names' ][ 1 : ]
thisParser = self.subparsers.add_parser( thisName,
aliases = thisAliases )
log.debug( 'Adding subcommand, {0}'.format( thisName ) )
self.subcommands.append( CommandTreeNode( thisName, thisParser,
specification = thisSpecification ) )
else :
log.debug( 'No subcommands in node' )
class CommandTree( CommandTreeNode ) :
"""
Construct the command tree from a specification dictionary.
"""
def __init__( self,
specification = None ) :
parser = argparse.ArgumentParser()
super().__init__( 'top', parser,
specification = specification )
def parse( self, commandLineArguments: list ) -> argparse.Namespace :
return self.parser.parse_args( commandLineArguments )
PK ljM K , contactList/arguments/base/tests/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
PK ljM A' ' 3 contactList/arguments/base/tests/testCommandTree.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test command tree construction.
"""
import unittest
from ..tree import CommandTree
class TestSingleOptionTree( unittest.TestCase ) :
"""
Test generating a parse tree for a single optional, top level argument.
"""
def setUp( self ) :
self.optionsSpecification = {
# A single, optional argument
'arguments' : [
{
'names' : [ '--option' ],
'options' : {
'default' : 5,
'dest' : 'thisOption',
'type' : int,
},
},
],
'options' : dict(),
# No subcommands
'subcommands' : list(),
}
def testDefault( self ) :
"""
Test that the default value is correctly parsed.
"""
expectedValue = self.optionsSpecification[ 'arguments' ][ 0 ][ 'options' ][ 'default' ]
inputValue = list()
thisTree = CommandTree( self.optionsSpecification )
parsedArguments = thisTree.parse( inputValue )
self.assertEqual( expectedValue, parsedArguments.thisOption )
self.assertTrue( isinstance( parsedArguments.thisOption, int ) )
def testSpecified( self ) :
"""
Test that a specified value for the argument is correctly parsed.
"""
expectedValue = 10
inputValue = [
'--option',
'{0}'.format( expectedValue ),
]
thisTree = CommandTree( self.optionsSpecification )
parsedArguments = thisTree.parse( inputValue )
self.assertEqual( expectedValue, parsedArguments.thisOption )
self.assertTrue( isinstance( parsedArguments.thisOption, int ) )
class TestSingleSubcommandTree( unittest.TestCase ) :
"""
Test a single subcommand with a single optional argument.
"""
def setUp( self ) :
self.optionsSpecification = {
'options' : dict(),
'subcommands' : [
{
'names' : [ 'subc' ],
'specification' : {
# A single, optional argument
'arguments' : [
{
'names' : [ '--option' ],
'options' : {
'default' : 5,
'dest' : 'thisOption',
'type' : int,
},
},
],
'options' : dict(),
# No subcommands of 'subc'
'subcommands' : list(),
},
},
],
'arguments' : list(),
}
def testDefault( self ) :
"""
Test that the default value is correctly parsed.
"""
thisSpecification = self.optionsSpecification[ 'subcommands' ][ 0 ][ 'specification' ]
expectedValue = thisSpecification[ 'arguments' ][ 0 ][ 'options' ][ 'default' ]
inputValue = [
'subc',
]
thisTree = CommandTree( self.optionsSpecification )
parsedArguments = thisTree.parse( inputValue )
self.assertEqual( expectedValue, parsedArguments.thisOption )
self.assertTrue( isinstance( parsedArguments.thisOption, int ) )
def testSpecified( self ) :
"""
Test that the default value is correctly parsed.
"""
expectedValue = 10
inputValue = [
'subc',
'--option',
'{0}'.format( expectedValue ),
]
thisTree = CommandTree( self.optionsSpecification )
parsedArguments = thisTree.parse( inputValue )
self.assertEqual( expectedValue, parsedArguments.thisOption )
self.assertTrue( isinstance( parsedArguments.thisOption, int ) )
class TestAliasedSubcommandTree( unittest.TestCase ) :
"""
Test a single subcommand with a subcommand alias.
"""
def setUp( self ) :
self.optionsSpecification = {
'arguments' : list(),
'options' : dict(),
'subcommands' : [
{
'names' : [ 'subc', 'sc' ],
'specification' : {
# A single, optional argument
'arguments' : [
{
'names' : [ '--option' ],
'options' : {
'default' : 5,
'dest' : 'thisOption',
'type' : int,
},
},
],
'options' : dict(),
# No subcommands of 'subc'
'subcommands' : list(),
},
},
],
}
def testDefault( self ) :
"""
Test that the default value is correctly parsed.
"""
thisSpecification = self.optionsSpecification[ 'subcommands' ][ 0 ][ 'specification' ]
expectedValue = thisSpecification[ 'arguments' ][ 0 ][ 'options' ][ 'default' ]
inputValue = [
'sc',
]
thisTree = CommandTree( self.optionsSpecification )
parsedArguments = thisTree.parse( inputValue )
self.assertEqual( expectedValue, parsedArguments.thisOption )
self.assertTrue( isinstance( parsedArguments.thisOption, int ) )
class TestSubcommandDestOption( unittest.TestCase ) :
"""
Test specifying subcommand options.
"""
def setUp( self ) :
self.optionsSpecification = {
'arguments' : list(),
'subcommands' : [
{
'names' : [ 'subc' ],
'specification' : {
# No arguments
'arguments' : list(),
'options' : {
'dest' : 'subcCommand',
},
# A single subcommand
'subcommands' : [
{
'names' : [ 'subsub' ],
'options' : dict(),
'specification' : {
'subcommands' : list(),
'arguments' : list(),
},
},
],
},
},
],
}
def testDefault( self ) :
"""
Test that the default value is correctly parsed.
"""
inputValue = [
'subc',
'subsub',
]
thisTree = CommandTree( self.optionsSpecification )
parsedArguments = thisTree.parse( inputValue )
self.assertEqual( 'subsub', parsedArguments.subcCommand )
class TestMissingParameters( unittest.TestCase ) :
"""
Missing parameters must be assumed empty.
"""
def testMissingArguments( self ) :
"""
No exceptions raised with missing arguments parameter.
"""
self.optionsSpecification = {
# arguments missing at this level.
'subcommands' : [
{
'names' : [ 'subc' ],
'specification' : {
'arguments' : list(),
'options' : dict(),
'subcommands' : list(),
},
},
],
}
inputValue = [
'subc',
]
thisTree = CommandTree( self.optionsSpecification )
parsedArguments = thisTree.parse( inputValue )
def testMissingOptions( self ) :
"""
No exceptions raised with missing options parameter.
"""
self.optionsSpecification = {
'arguments' : list(),
'subcommands' : [
{
'names' : [ 'subc' ],
'specification' : {
'arguments' : list(),
# Missing options at this level.
'subcommands' : list(),
},
},
],
}
inputValue = [
'subc',
]
thisTree = CommandTree( self.optionsSpecification )
parsedArguments = thisTree.parse( inputValue )
def testMissingSubcommands( self ) :
"""
No exceptions raised with missing subcommands parameter.
"""
self.optionsSpecification = {
'arguments' : list(),
'subcommands' : [
{
'names' : [ 'subc' ],
'specification' : {
'arguments' : list(),
'options' : dict(),
# Missing subcommands at this level.
},
},
],
}
inputValue = [
'subc',
]
thisTree = CommandTree( self.optionsSpecification )
parsedArguments = thisTree.parse( inputValue )
if __name__ == '__main__' :
unittest.main()
PK ljMJ* * ) contactList/arguments/cluster/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Cluster command line argument data and parsing.
"""
from .cluster import CLUSTER_SUBCOMMAND_GRAPH
PK ljM(G $ contactList/arguments/cluster/add.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Subcommand graph for `cluster add`.
"""
CLUSTER_ARGUMENT = {
'names' : [ 'cluster', ],
'options' : {
'help' : 'Cluster to Add.',
'nargs' : '+',
'type' : str,
},
}
ADD_CLUSTER_SUBCOMMAND_GRAPH = {
'names' : [ 'add', ],
'options' : {
'help' : 'Add a cluster.',
},
'specification' : {
'subcommands' : list(),
'arguments' : [
CLUSTER_ARGUMENT,
],
},
}
PK ljM
9 ( contactList/arguments/cluster/cluster.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Subcommand graph for `cluster`.
"""
from .add import ADD_CLUSTER_SUBCOMMAND_GRAPH
from .rm import RM_CLUSTER_SUBCOMMAND_GRAPH
CLUSTER_SUBCOMMAND_GRAPH = {
'names' : [ 'cluster', ],
'specification' : {
'arguments' : list(),
'options' : {
'dest' : 'clusterCommand',
'help' : 'Add/remove operations',
'title': 'Cluster management',
},
'subcommands' : [
ADD_CLUSTER_SUBCOMMAND_GRAPH,
RM_CLUSTER_SUBCOMMAND_GRAPH,
],
},
}
PK ljMްY # contactList/arguments/cluster/rm.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Subcommand graph for `cluster rm`.
"""
CLUSTER_ARGUMENT = {
'names' : [ 'cluster', ],
'options' : {
'help' : 'Cluster to remove or modify',
'nargs' : '+',
'type' : str,
},
}
GROUP_ARGUMENT = {
'names' : [ '--group', '-g', '--groups' ],
'options' : {
'default' : list(),
'dest' : 'groups',
'help' : 'Group to remove from cluster',
'nargs' : '+',
'type' : str,
},
}
RM_CLUSTER_SUBCOMMAND_GRAPH = {
'names' : [ 'rm', ],
'options' : {
'dest' : 'remove',
'help' : 'Remove a cluster or group from cluster.',
},
'specification' : {
'subcommands' : list(),
'arguments' : [
CLUSTER_ARGUMENT,
GROUP_ARGUMENT,
],
},
}
PK ljM K / contactList/arguments/cluster/tests/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
PK ljMҍ{M 2 contactList/arguments/cluster/tests/testCluster.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test `cluster` subcommand.
"""
import unittest
from contactList.arguments.base import CommandTree
from ..cluster import CLUSTER_SUBCOMMAND_GRAPH
class TestClusterCommand( unittest.TestCase ) :
MOCK_COMMAND_GRAPH = {
'subcommands' : [
CLUSTER_SUBCOMMAND_GRAPH,
]
}
def setUp( self ) :
self.commandUnderTest = CommandTree( specification = self.MOCK_COMMAND_GRAPH )
def processArguments( self, inputValue ) :
return self.commandUnderTest.parse( inputValue )
def testAdd( self ) :
inputValue = [
'cluster',
'add',
'myCluster',
]
parsedArguments = self.processArguments( inputValue )
self.assertEqual( inputValue[ 1 ], parsedArguments.clusterCommand )
self.assertEqual( [ inputValue[ 2 ] ], parsedArguments.cluster )
def testRm( self ) :
inputValue = [
'cluster',
'rm',
'myCluster',
]
parsedArguments = self.processArguments( inputValue )
self.assertEqual( inputValue[ 1 ], parsedArguments.clusterCommand )
self.assertEqual( [ inputValue[ 2 ] ], parsedArguments.cluster )
if __name__ == '__main__' :
unittest.main()
PK ljMGT\A 5 contactList/arguments/cluster/tests/testClusterAdd.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test `cluster add` subcommand.
"""
import unittest
from contactList.arguments.base import CommandTree
from ..add import ADD_CLUSTER_SUBCOMMAND_GRAPH
class TestAddClusterSubcommand( unittest.TestCase ) :
MOCK_COMMAND_GRAPH = {
'subcommands' : [
ADD_CLUSTER_SUBCOMMAND_GRAPH,
]
}
def setUp( self ) :
self.commandUnderTest = CommandTree( specification = self.MOCK_COMMAND_GRAPH )
def processArguments( self, inputValue ) :
return self.commandUnderTest.parse( inputValue )
def testAddClusterShortForm( self ) :
inputValue = [
'add',
'myCluster',
]
parseArguments = self.processArguments( inputValue )
self.assertEqual( [ inputValue[ 1 ] ], parseArguments.cluster )
if __name__ == '__main__' :
unittest.main()
PK ljM$B0
4 contactList/arguments/cluster/tests/testClusterRm.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test `cluster rm` subcommand.
"""
import unittest
from contactList.arguments.base import CommandTree
from ..rm import RM_CLUSTER_SUBCOMMAND_GRAPH
class TestRmClusterSubcommand( unittest.TestCase ) :
MOCK_COMMAND_GRAPH = {
'subcommands' : [
RM_CLUSTER_SUBCOMMAND_GRAPH,
]
}
def setUp( self ) :
self.commandUnderTest = CommandTree( specification = self.MOCK_COMMAND_GRAPH )
def processArguments( self, inputValue ) :
return self.commandUnderTest.parse( inputValue )
def testRemoveCluster( self ) :
inputValue = [
'rm',
'myCluster',
]
parseArguments = self.processArguments( inputValue )
self.assertEqual( [ inputValue[ 1 ] ], parseArguments.cluster )
self.assertEqual( list(), parseArguments.groups )
def testRemoveClusterGroupLongForm( self ) :
inputValue = [
'rm',
'myCluster',
'--group',
'myGroup'
]
parseArguments = self.processArguments( inputValue )
self.assertEqual( [ inputValue[ 1 ] ], parseArguments.cluster )
self.assertEqual( [ inputValue[ 3 ] ], parseArguments.groups )
def testRemoveClusterGroupShortForm( self ) :
inputValue = [
'rm',
'myCluster',
'-g',
'myGroup'
]
parseArguments = self.processArguments( inputValue )
self.assertEqual( [ inputValue[ 1 ] ], parseArguments.cluster )
self.assertEqual( [ inputValue[ 3 ] ], parseArguments.groups )
def testRemoveClusterGroupPluralForm( self ) :
inputValue = [
'rm',
'myCluster',
'--groups',
'myGroup'
]
parseArguments = self.processArguments( inputValue )
self.assertEqual( [ inputValue[ 1 ] ], parseArguments.cluster )
self.assertEqual( [ inputValue[ 3 ] ], parseArguments.groups )
if __name__ == '__main__' :
unittest.main()
PK ljM $ $ ' contactList/arguments/email/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Email command line argument parsing and data.
"""
from .email import EMAIL_SUBCOMMAND_GRAPH
PK ljMߨ " contactList/arguments/email/add.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Subcommand graph for `email add`.
"""
EMAIL_ARGUMENT = {
'names' : [ 'email', ],
'options' : {
'help' : 'Email address(es) to add',
'nargs' : '+',
'type' : str,
},
}
GROUP_ARGUMENT = {
'names' : [ '--group', '-g', '--groups' ],
'options' : {
'default' : list(),
'dest' : 'groups',
'help' : 'Group to add email to (optional, default all).',
'nargs' : '+',
'type' : str,
},
}
ADD_EMAIL_SUBCOMMAND_GRAPH = {
'names' : [ 'add', ],
'options' : {
'help' : 'Remove a group from a selected cluster or clusters, or from all clusters.',
},
'specification' : {
'subcommands' : list(),
'arguments' : [
EMAIL_ARGUMENT,
GROUP_ARGUMENT,
],
},
}
PK ljM $ contactList/arguments/email/email.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Subcommand graph for `email`.
"""
from .add import ADD_EMAIL_SUBCOMMAND_GRAPH
from .rm import RM_EMAIL_SUBCOMMAND_GRAPH
EMAIL_SUBCOMMAND_GRAPH = {
'names' : [ 'email', ],
'specification' : {
'arguments' : list(),
'options' : {
'dest' : 'emailCommand',
'help' : 'Add/remove operations',
'title' : 'Email management',
},
'subcommands' : [
ADD_EMAIL_SUBCOMMAND_GRAPH,
RM_EMAIL_SUBCOMMAND_GRAPH,
],
},
}
PK ljM\ ! contactList/arguments/email/rm.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Subcommand graph for `email rm`.
"""
EMAIL_ARGUMENT = {
'names' : [ 'email', ],
'options' : {
'help' : 'Email address(es) to remove',
'nargs' : '+',
'type' : str,
},
}
GROUP_ARGUMENT = {
'names' : [ '--group', '-g', '--groups' ],
'options' : {
'default' : list(),
'dest' : 'groups',
'help' : 'Group(s) from which to remove the email address (optional, default all)',
'nargs' : '+',
'type' : str,
},
}
RM_EMAIL_SUBCOMMAND_GRAPH = {
'names' : [ 'rm', ],
'options' : {
'dest': 'remove',
'help' : 'Remove an email from a selected group or groups, or from all groups.',
},
'specification' : {
'subcommands' : list(),
'arguments' : [
EMAIL_ARGUMENT,
GROUP_ARGUMENT,
],
},
}
PK ljM K - contactList/arguments/email/tests/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
PK ljMΠ4ɓ . contactList/arguments/email/tests/testEmail.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test `email` subcommand.
"""
import unittest
from contactList.arguments.base import CommandTree
from ..email import EMAIL_SUBCOMMAND_GRAPH
class TestEmailCommand( unittest.TestCase ) :
MOCK_COMMAND_GRAPH = {
'subcommands' : [
EMAIL_SUBCOMMAND_GRAPH,
]
}
def setUp( self ) :
self.commandUnderTest = CommandTree( specification = self.MOCK_COMMAND_GRAPH )
def processArguments( self, inputValue ) :
return self.commandUnderTest.parse( inputValue )
def testAdd( self ) :
inputValue = [
'email',
'add',
'myEmail',
]
parsedArguments = self.processArguments( inputValue )
self.assertEqual( inputValue[ 1 ], parsedArguments.emailCommand )
self.assertEqual( [ inputValue[ 2 ] ], parsedArguments.email )
def testRm( self ) :
inputValue = [
'email',
'rm',
'myEmail',
]
parsedArguments = self.processArguments( inputValue )
self.assertEqual( inputValue[ 1 ], parsedArguments.emailCommand )
self.assertEqual( [ inputValue[ 2 ] ], parsedArguments.email )
if __name__ == '__main__' :
unittest.main()
PK ljM[l 1 contactList/arguments/email/tests/testEmailAdd.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test `email add` subcommand.
"""
import unittest
from contactList.arguments.base import CommandTree
from ..add import ADD_EMAIL_SUBCOMMAND_GRAPH
class TestAddEmailSubcommand( unittest.TestCase ) :
MOCK_COMMAND_GRAPH = {
'subcommands' : [
ADD_EMAIL_SUBCOMMAND_GRAPH,
]
}
def setUp( self ) :
self.commandUnderTest = CommandTree( specification = self.MOCK_COMMAND_GRAPH )
def processArguments( self, inputValue ) :
return self.commandUnderTest.parse( inputValue )
def testAddEmail( self ) :
inputValue = [
'add',
'someone@somewhere.com',
]
parsedArguments = self.processArguments( inputValue )
self.assertEqual( [ inputValue[ 1 ] ], parsedArguments.email )
self.assertEqual( list(), parsedArguments.groups )
def testAddEmailInGroupShortForm( self ) :
inputValue = [
'add',
'someone@somewhere.com',
'-g',
'myGroup',
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], [ inputValue[ 3 ] ] )
def testAddEmailInGroupLongForm( self ) :
inputValue = [
'add',
'someone@somewhere.com',
'--group',
'myGroup',
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], [ inputValue[ 3 ] ] )
def doEmailInGroupTest( self, inputValue, expectedEmail, expectedGroups ) :
parsedArguments = self.processArguments( inputValue )
self.assertEqual( expectedEmail, parsedArguments.email )
self.assertEqual( expectedGroups, parsedArguments.groups )
def testAddEmailInGroupsShortForm( self ) :
expectedList = [ 'group1', 'group2' ]
inputValue = [
'add',
'someone@somewhere.com',
'-g',
'group1',
'group2',
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], expectedList )
def testAddEmailInGroupsLongForm( self ) :
expectedList = [ 'group1', 'group2' ]
inputValue = [
'add',
'someone@somewhere.com',
'--group',
'group1',
'group2',
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], expectedList )
if __name__ == '__main__' :
unittest.main()
PK ljM=A 0 contactList/arguments/email/tests/testEmailRm.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test `email rm` subcommand.
"""
import unittest
from contactList.arguments.base import CommandTree
from ..rm import RM_EMAIL_SUBCOMMAND_GRAPH
class TestRmEmailSubcommand( unittest.TestCase ) :
MOCK_COMMAND_GRAPH = {
'subcommands' : [
RM_EMAIL_SUBCOMMAND_GRAPH,
]
}
def setUp( self ) :
self.commandUnderTest = CommandTree( specification = self.MOCK_COMMAND_GRAPH )
def processArguments( self, inputValue ) :
return self.commandUnderTest.parse( inputValue )
def testRemoveEmail( self ) :
inputValue = [
'rm',
'someone@somewhere.com',
]
parsedArguments = self.processArguments( inputValue )
self.assertEqual( [ inputValue[ 1 ] ], parsedArguments.email )
self.assertEqual( list(), parsedArguments.groups )
def testRemoveEmailInGroupShortForm( self ) :
inputValue = [
'rm',
'someone@somewhere.com',
'-g',
'myGroup',
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], [ inputValue[ 3 ] ] )
def testRemoveEmailInGroupLongForm( self ) :
inputValue = [
'rm',
'someone@somewhere.com',
'--group',
'myGroup',
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], [ inputValue[ 3 ] ] )
def doEmailInGroupTest( self, inputValue, expectedEmail, expectedGroups ) :
parsedArguments = self.processArguments( inputValue )
self.assertEqual( expectedEmail, parsedArguments.email )
self.assertEqual( expectedGroups, parsedArguments.groups )
def testRemoveEmailInGroupsShortForm( self ) :
expectedList = [ 'group1', 'group2' ]
inputValue = [
'rm',
'someone@somewhere.com',
'-g',
'group1',
'group2',
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], expectedList )
def testRemoveEmailInGroupsLongForm( self ) :
expectedList = [ 'group1', 'group2' ]
inputValue = [
'rm',
'someone@somewhere.com',
'--group',
'group1',
'group2',
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], expectedList )
if __name__ == '__main__' :
unittest.main()
PK ljM7o ' contactList/arguments/group/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Group subcommand parsing implementation.
"""
from .group import GROUP_SUBCOMMAND_GRAPH
PK ljM>/ɟ " contactList/arguments/group/add.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Subcommand graph for `group add`.
"""
GROUP_ARGUMENT = {
'names' : [ 'group', ],
'options' : {
'help' : 'Group(s) to add.',
'nargs' : '+',
'type' : str,
},
}
CLUSTER_ARGUMENT = {
'names' : [ '--cluster', '-c', '--clusters' ],
'options' : {
'default' : list(),
'dest' : 'clusters',
'help' : 'Cluster to add group to (optional, default all).',
'nargs' : '+',
'type' : str,
},
}
ADD_GROUP_SUBCOMMAND_GRAPH = {
'names' : [ 'add', ],
'options' : {
'help' : 'Add a group to a cluster or clusters, or to all clusters.',
},
'specification' : {
'subcommands' : list(),
'arguments' : [
GROUP_ARGUMENT,
CLUSTER_ARGUMENT,
],
},
}
PK ljM9 $ contactList/arguments/group/group.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Subcommand graph for `group` .
"""
from .add import ADD_GROUP_SUBCOMMAND_GRAPH
from .rm import RM_GROUP_SUBCOMMAND_GRAPH
GROUP_SUBCOMMAND_GRAPH = {
'names' : [ 'group', ],
'specification' : {
'arguments' : list(),
'options' : {
'dest' : 'groupCommand',
'help' : 'Add/remove operations',
'title': 'Group management',
},
'subcommands' : [
ADD_GROUP_SUBCOMMAND_GRAPH,
RM_GROUP_SUBCOMMAND_GRAPH,
],
},
}
PK ljM{mr=J J ! contactList/arguments/group/rm.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Subcommand graph for `group rm`.
"""
GROUP_ARGUMENT = {
'names' : [ 'group', ],
'options' : {
'help' : 'Group(s) to remove',
'nargs' : '+',
'type' : str,
},
}
CLUSTER_ARGUMENT = {
'names' : [ '--cluster', '-c', '--clusters' ],
'options' : {
'default' : list(),
'dest' : 'clusters',
'help' : 'Cluster(s) from which to remove the group',
'nargs' : '+',
'type' : str,
},
}
KEEP_ARGUMENT = {
'names' : [ '--no-keep', '-n', ],
'options' : {
'action' : 'store_false',
'dest' : 'keep',
'help' : 'Remove the group itself from contacts when removing from all clusters. Any email addresses unique '
'to the group will be lost.',
},
}
RM_GROUP_SUBCOMMAND_GRAPH = {
'names' : [ 'rm', ],
'options' : {
'dest' : 'remove',
'help' : 'Remove a group from a selected cluster or clusters, or from all clusters.',
},
'specification' : {
'subcommands' : list(),
'arguments' : [
GROUP_ARGUMENT,
CLUSTER_ARGUMENT,
KEEP_ARGUMENT,
],
},
}
PK ljM K - contactList/arguments/group/tests/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
PK ljMU0
. contactList/arguments/group/tests/testGroup.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test the `group` subcommand.
"""
import io
import logging
import unittest
from contactList.arguments.base import CommandTree
from contactList.tests.utility import redirect_stdout_stderr
from ..group import GROUP_SUBCOMMAND_GRAPH
class TestGroupCommand( unittest.TestCase ) :
MOCK_COMMAND_GRAPH = {
'subcommands' : [
GROUP_SUBCOMMAND_GRAPH,
]
}
def setUp( self ) :
logging.disable( logging.CRITICAL )
self.commandUnderTest = CommandTree( specification = self.MOCK_COMMAND_GRAPH )
def tearDown( self ) :
logging.disable( logging.NOTSET )
def processArguments( self, inputValue ) :
parsedArguments = self.commandUnderTest.parse( inputValue )
return parsedArguments
def testBadGroupRaises( self ) :
inputValue = [
'group',
'badcommand'
]
# Some gymnastics to suppress spurious logging in unittest output.
file = io.StringIO()
with redirect_stdout_stderr( file ) :
with self.assertRaises( SystemExit ) :
self.processArguments( inputValue )
def testGroupAdd( self ) :
inputValue = [
'group',
'add',
'myGroup',
]
parsedArguments = self.processArguments( inputValue )
self.assertEqual( inputValue[ 1 ], parsedArguments.groupCommand )
self.assertEqual( [inputValue[ 2 ]], parsedArguments.group )
self.assertEqual( list(), parsedArguments.clusters )
def testGroupRm( self ) :
inputValue = [
'group',
'rm',
'myGroup',
]
parsedArguments = self.processArguments( inputValue )
self.assertEqual( inputValue[ 1 ], parsedArguments.groupCommand )
self.assertEqual( [inputValue[ 2 ]], parsedArguments.group )
self.assertEqual( list(), parsedArguments.clusters )
if __name__ == '__main__' :
unittest.main()
PK ljMCP 1 contactList/arguments/group/tests/testGroupAdd.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test the group add subcommand.
"""
import unittest
from contactList.arguments.base import CommandTree
from ..add import ADD_GROUP_SUBCOMMAND_GRAPH
class TestAddGroupSubcommand( unittest.TestCase ) :
MOCK_COMMAND_GRAPH = {
'subcommands' : [
ADD_GROUP_SUBCOMMAND_GRAPH,
]
}
def setUp( self ) :
self.commandUnderTest = CommandTree( specification = self.MOCK_COMMAND_GRAPH )
def testAddGroup( self ) :
inputValue = [
'add',
'myGroup',
]
parsedArguments = self.processArguments( inputValue )
self.assertEqual( [ inputValue[ 1 ] ], parsedArguments.group )
self.assertEqual( list(), parsedArguments.clusters )
def processArguments( self, inputValue ) :
return self.commandUnderTest.parse( inputValue )
def testAddGroupInGroupShortForm( self ) :
inputValue = [
'add',
'myGroup',
'-c',
'myCluster',
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], [ inputValue[ 3 ] ] )
def testAddGroupInGroupLongForm( self ) :
inputValue = [
'add',
'myGroup',
'--cluster',
'myCluster',
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], [ inputValue[ 3 ] ] )
def doEmailInGroupTest( self, inputValue, expectedGroup, expectedClusters ) :
parsedArguments = self.processArguments( inputValue )
self.assertEqual( expectedGroup, parsedArguments.group )
self.assertEqual( expectedClusters, parsedArguments.clusters )
def testAddGroupInGroupsShortForm( self ) :
expectedList = [ 'cluster1', 'cluster2' ]
inputValue = [
'add',
'myGroup',
'-c',
'cluster1',
'cluster2',
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], expectedList )
def testAddGroupInGroupsLongForm( self ) :
expectedList = [ 'cluster1', 'cluster2' ]
inputValue = [
'add',
'myGroup',
'--cluster',
'cluster1',
'cluster2',
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], expectedList )
if __name__ == '__main__' :
unittest.main()
PK ljMOZG G 0 contactList/arguments/group/tests/testGroupRm.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test the group rm subcommand.
"""
import unittest
from contactList.arguments.base import CommandTree
from ..rm import RM_GROUP_SUBCOMMAND_GRAPH
class TestRmGroupSubcommand( unittest.TestCase ) :
MOCK_COMMAND_GRAPH = {
'subcommands' : [
RM_GROUP_SUBCOMMAND_GRAPH,
]
}
def setUp( self ) :
self.commandUnderTest = CommandTree( specification = self.MOCK_COMMAND_GRAPH )
def testRemoveGroup( self ) :
inputValue = [
'rm',
'myGroup',
]
parsedArguments = self.processArguments( inputValue )
self.assertEqual( [ inputValue[ 1 ] ], parsedArguments.group )
self.assertEqual( list(), parsedArguments.clusters )
self.assertTrue( parsedArguments.keep )
def processArguments( self, inputValue ) :
return self.commandUnderTest.parse( inputValue )
def testRemoveGroupInClusterShortForm( self ) :
inputValue = [
'rm',
'myGroup',
'-c',
'myCluster',
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], [ inputValue[ 3 ] ] )
def testRemoveGroupInClusterLongForm( self ) :
inputValue = [
'rm',
'myGroup',
'--cluster',
'myCluster',
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], [ inputValue[ 3 ] ] )
def doEmailInGroupTest( self, inputValue, expectedGroup, expectedClusters,
expectedKeep = True ) :
parsedArguments = self.processArguments( inputValue )
self.assertEqual( expectedGroup, parsedArguments.group )
self.assertEqual( expectedClusters, parsedArguments.clusters )
self.assertEqual( expectedKeep, parsedArguments.keep )
def testRemoveGroupInClustersShortForm( self ) :
expectedList = [ 'cluster1', 'cluster2' ]
inputValue = [
'rm',
'myGroup',
'-c',
'cluster1',
'cluster2',
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], expectedList )
def testRemoveGroupInClustersLongForm( self ) :
expectedList = [ 'cluster1', 'cluster2' ]
inputValue = [
'rm',
'myGroup',
'--cluster',
'cluster1',
'cluster2',
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], expectedList )
def testRemoveGroupWithNoKeepShortForm( self ) :
inputValue = [
'rm',
'myGroup',
'--cluster',
'myCluster',
'-n'
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], [ inputValue[ 3 ] ],
expectedKeep = False )
def testRemoveGroupWithNoKeepLongForm( self ) :
inputValue = [
'rm',
'myGroup',
'--cluster',
'myCluster',
'--no-keep'
]
self.doEmailInGroupTest( inputValue, [ inputValue[ 1 ] ], [ inputValue[ 3 ] ],
expectedKeep = False )
if __name__ == '__main__' :
unittest.main()
PK ljM K ' contactList/arguments/tests/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
PK ljMPy y + contactList/arguments/tests/testParseTop.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test the top level command line argument parser.
"""
import unittest
from ..base import BadArgument
from ..top import ContactsOptions
class TestParseArguments( unittest.TestCase ) :
def testNoSubcommandRaises( self ) :
inputValue = [
]
with self.assertRaisesRegex( BadArgument, '^Must specify a contact list operation' ) :
ContactsOptions.from_arguments( inputValue )
def testContactsFileShortForm( self ) :
inputValue = [
'-f',
'someFile.yml',
'cluster',
'add',
'someName',
]
self.doContactsFileTest( inputValue )
def doContactsFileTest( self, inputValue ) :
actualOptions = ContactsOptions.from_arguments( inputValue )
self.assertEqual( inputValue[ 1 ], actualOptions.contactsFile )
return actualOptions
def testContactsFileLongForm( self ) :
inputValue = [
'--file',
'someFile.yml',
'cluster',
'add',
'someName',
]
self.doContactsFileTest( inputValue )
def testAddCluster( self ) :
inputValue = [
'cluster',
'add',
'someName',
]
actualOptions = ContactsOptions.from_arguments( inputValue )
self.assertEqual( inputValue[ 0 ], actualOptions.activeSubcommand )
self.assertEqual( 'contacts.yml', actualOptions.contactsFile )
def testAddEmail( self ) :
inputValue = [
'email',
'add',
'someName',
]
actualOptions = ContactsOptions.from_arguments( inputValue )
self.assertEqual( inputValue[ 0 ], actualOptions.activeSubcommand )
self.assertEqual( 'contacts.yml', actualOptions.contactsFile )
def testAddGroup( self ) :
inputValue = [
'group',
'add',
'someName',
]
actualOptions = ContactsOptions.from_arguments( inputValue )
self.assertEqual( inputValue[ 0 ], actualOptions.activeSubcommand )
self.assertEqual( 'contacts.yml', actualOptions.contactsFile )
def testRmCluster( self ) :
inputValue = [
'cluster',
'rm',
'someName',
]
actualOptions = ContactsOptions.from_arguments( inputValue )
self.assertEqual( inputValue[ 0 ], actualOptions.activeSubcommand )
self.assertEqual( 'contacts.yml', actualOptions.contactsFile )
def testRmEmail( self ) :
inputValue = [
'email',
'rm',
'someName',
]
actualOptions = ContactsOptions.from_arguments( inputValue )
self.assertEqual( inputValue[ 0 ], actualOptions.activeSubcommand )
self.assertEqual( 'contacts.yml', actualOptions.contactsFile )
def testRmGroup( self ) :
inputValue = [
'group',
'rm',
'someName',
]
actualOptions = ContactsOptions.from_arguments( inputValue )
self.assertEqual( inputValue[ 0 ], actualOptions.activeSubcommand )
self.assertEqual( 'contacts.yml', actualOptions.contactsFile )
if __name__ == '__main__' :
unittest.main()
PK ljMt]H[$ $ contactList/contacts/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
from .contact import Contacts
from .base import \
ContactsError, \
ContactsOperationErrorPK ljMD. contactList/contacts/contact.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Core Contacts class implementation.
"""
import logging
import os
import yaml
from ..arguments import ContactsOptions
from .base import ContactData
from .cluster import ClusterOperation
from .email import EmailOperation
from .group import GroupOperation
log = logging.getLogger( __name__ )
class Contacts :
"""
Management of contact groups and clusters.
"""
__DEFAULT_FILE = 'contacts.yml'
__YAML_KEYS = {
'cluster' : 'clusters',
'group' : 'groups',
}
def __init__( self ) :
self.data = ContactData()
self.subcommands = {
'cluster' : ClusterOperation(),
'email' : EmailOperation(),
'group' : GroupOperation(),
}
def applyAction( self, contactsOptions: ContactsOptions ) :
actionName = contactsOptions.activeSubcommand
subcommand = self.subcommands[ actionName ]
subcommand.applyOperation( self.data, contactsOptions )
def to_yamlFile( self,
filename = None,
fileObject = None ) :
"""
Write the contacts data to a file in YAML format. Either a filename or a file object must be specified,
or accept the default filename.
:param filename: (optional)
:param fileObject: (optional)
"""
assert not ((filename is not None) and (fileObject is not None))
if fileObject is None :
# Explicitly open a file.
if filename is None :
# Use default file name.
filePath = Contacts.__DEFAULT_FILE
else :
filePath = filename
with open( filePath, 'w' ) as fileObject :
self.__exportData( fileObject )
else :
# Use the user defined file object.
self.__exportData( fileObject )
def __exportData( self, fileObject ) :
exportYamlData = {
self.__YAML_KEYS[ 'cluster' ] : self.data.clusters,
self.__YAML_KEYS[ 'group' ] : self.data.groups,
}
yaml.dump( exportYamlData, fileObject )
def __parseGroups( self, yamlData ) :
if self.__YAML_KEYS[ 'group' ] in yamlData :
assert isinstance( yamlData[ self.__YAML_KEYS[ 'group' ] ], dict )
self.data.groups = yamlData[ self.__YAML_KEYS[ 'group' ] ]
def __parseClusters( self, yamlData ) :
if self.__YAML_KEYS[ 'cluster' ] in yamlData :
assert isinstance( yamlData[ self.__YAML_KEYS[ 'cluster' ] ], dict )
self.data.clusters = yamlData[ self.__YAML_KEYS[ 'cluster' ] ]
@classmethod
def from_yamlData( cls, yamlData ) :
"""
Recover contacts data from YAML data structure.
:param yamlData: YAML data loaded using ``yaml.load`` or ``yaml.safeload``.
:return: Constructed ``Contacts`` object.
"""
contactObject = cls()
if yamlData is not None :
contactObject.__parseGroups( yamlData )
contactObject.__parseClusters( yamlData )
return contactObject
@classmethod
def from_yamlFile( cls,
filename: str = None,
fileObject = None ) :
"""
Load contacts data from a YAML file or file object.
:param filename: Name of YAML file (optional)
:param fileObject: File object (optional)
:return: Constructed ``Contacts`` object.
"""
def loadData() :
yamlData = yaml.safe_load( fileObject )
thisObject = cls.from_yamlData( yamlData )
return thisObject
assert not ((filename is not None) and (fileObject is not None))
if fileObject is None :
# Explicitly open a file.
if filename is None :
# Use default file name.
filePath = Contacts.__DEFAULT_FILE
else :
filePath = filename
if os.path.isfile( filePath ) :
with open( filePath, 'r' ) as fileObject :
contactsObject = loadData()
else :
raise FileNotFoundError( 'File does not exist, {0}'.format( filePath ) )
else :
# Use the user defined file object.
contactsObject = loadData()
contactsObject.data.validate()
return contactsObject
PK ljMhf % contactList/contacts/base/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Core representation of contact data.
"""
from .abstract import OperationInterface
from .data import ContactData
from .exception import \
ContactsError, \
ContactsOperationError
PK ljMY % contactList/contacts/base/abstract.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Abstract interfaces.
"""
import abc
from contactList.arguments import ContactsOptions
class OperationInterface( metaclass = abc.ABCMeta ) :
"""
Abstract interface to any class performing a command line operation on contact data.
"""
@abc.abstractmethod
def applyOperation( self, contactData, contactsOptions: ContactsOptions ) :
"""
Redirect the command line subcommand to the specific requested subcommand to take action on contacts data.
:param contactData:
:param contactsOptions:
"""
pass
PK ljM?/s s ! contactList/contacts/base/data.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Core representation of contacts data.
"""
import logging
from .exception import ContactsError
log = logging.getLogger( __name__ )
class ContactData :
"""
Core representation of contacts list.
"""
__DEFAULT_FILE = 'contacts.yml'
__KEYS = {
'cluster' : 'clusters',
'group' : 'groups',
}
def __init__( self ) :
self.groups = dict()
self.clusters = dict()
def emails( self, clusterName ) :
"""
Aggregate the emails from the named cluster.
:param clusterName: Cluster name to get emails from.
:return: set of emails.
"""
collectedEmails = set()
for thisGroupName in self.clusters[ clusterName ] :
collectedEmails |= set( self.groups[ thisGroupName ] )
return collectedEmails
def validate( self ) :
"""
Check that the group and cluster declarations are sane.
Log errors found and raise ``ContactsError`` on completion of a review with errors.
"""
groupsOkay = True
for thisCluster, groups in self.clusters.items() :
for thisGroup in groups :
if thisGroup not in self.groups :
groupsOkay &= False
log.error( 'Group not defined, {0} (cluster, {1})'.format( thisGroup, thisCluster ) )
if not groupsOkay :
raise ContactsError( 'Group(s) in cluster not defined' )
PK ljME E & contactList/contacts/base/exception.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Contacts exceptions.
"""
class ContactsError( Exception ) :
pass
class ContactsOperationError( Exception ) :
pass
PK ljM K + contactList/contacts/base/tests/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
PK ljM_>+ 8 contactList/contacts/base/tests/testContactValidation.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test contact data validation.
"""
import unittest
from ..data import \
ContactData, \
ContactsError
class TestContactValidation( unittest.TestCase ) :
def testMissingGroupsRaises( self ) :
contactsUnderTest = ContactData()
contactsUnderTest.clusters = {
'one' : [ 'a', 'b' ],
'two' : [ 'c', 'd' ],
}
with self.assertRaisesRegex( ContactsError, '^Group\(s\) in cluster not defined' ) :
contactsUnderTest.validate()
if __name__ == '__main__' :
unittest.main()
PK ljM
w. 0 contactList/contacts/base/tests/testEmailList.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test email list extractions from contacts list.
"""
import unittest
from .. import ContactData
class TestContactEmails( unittest.TestCase ) :
def setUp( self ) :
groups = {
'group1' : [ 'a@g1.com', 'b@g2.ca', ],
'group2' : [ 'c@g3.co.uk', ],
}
clusters = {
'c1' : [ 'group1', 'group2' ],
'c2' : [ 'group1' ],
}
self.contactsUnderTest = ContactData()
self.contactsUnderTest.groups = groups
self.contactsUnderTest.clusters = clusters
def testEmailsC1( self ) :
"""
Multiple groups of emails are correctly aggregated in a cluster.
"""
expectedEmails = set( self.contactsUnderTest.groups[ 'group1' ] ) | set(
self.contactsUnderTest.groups[ 'group2' ] )
actualEmails = self.contactsUnderTest.emails( 'c1' )
self.assertEqual( expectedEmails, actualEmails )
def testEmailsC2( self ) :
"""
A single group of emails is correctly extracted from a cluster.
"""
expectedEmails = set( self.contactsUnderTest.groups[ 'group1' ] )
actualEmails = self.contactsUnderTest.emails( 'c2' )
self.assertEqual( expectedEmails, actualEmails )
if __name__ == '__main__' :
unittest.main()
PK ljM0G" " ( contactList/contacts/cluster/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Manage cluster properties in a contacts list.
"""
from .operation import ClusterOperation
PK ljM,] ) contactList/contacts/cluster/operation.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Manage cluster properties in a contacts list.
"""
import logging
from contactList.arguments import ContactsOptions
from ..base import \
ContactData, \
OperationInterface
log = logging.getLogger( __name__ )
class ClusterOperation( OperationInterface ) :
"""
Manage cluster properties in a contacts list.
"""
def __init__( self ) :
self.commands = {
'add' : {
'args' : extractAddArguments,
'operation' : add,
},
'rm' : {
'args' : extractRemoveArguments,
'operation' : remove,
},
}
def applyOperation( self, contactData: ContactData, contactsOptions: ContactsOptions ) :
"""
Redirect the command line subcommand to the specific requested subcommand to take group related actions on
contacts data.
:param contactData:
:param contactsOptions:
"""
emailCommand = contactsOptions.clusterCommand
(args, kwargs) = self.commands[ emailCommand ][ 'args' ]( contactData, contactsOptions )
self.commands[ emailCommand ][ 'operation' ]( *args, **kwargs )
def extractAddArguments( contactData: ContactData, contactsOptions: ContactsOptions ) :
args = [
contactData,
contactsOptions.cluster,
]
kwargs = dict()
return args, kwargs
def extractRemoveArguments( contactData: ContactData, contactsOptions: ContactsOptions ) :
args = [
contactData,
contactsOptions.cluster,
]
kwargs = {
'groups' : contactsOptions.groups,
}
return args, kwargs
def add( contactData: ContactData, clusters: list ) -> ContactData :
"""
Add groups to specified clusters. If groups is ``None`` then add the cluster.
Attempting to add an existing cluster is silently ignored, and the existing cluster is unmodified.
:param contactData:
:param clusters: List of cluster names to add groups to.
:return: Modified contacts.
"""
for thisCluster in clusters :
if thisCluster not in contactData.clusters :
contactData.clusters[ thisCluster ] = list()
log.info( 'Added new cluster, {0}'.format( thisCluster ) )
else :
# Warn the user that this is being ignored.
log.warning( 'Cannot add a cluster that already exists, {0}'.format( thisCluster ) )
contactData.validate()
return contactData
def remove( contactData: ContactData, clusters: list,
groups: list = None ) -> ContactData :
"""
Remove groups from specified clusters. If groups is ``None`` then remove the cluster.
Removing a non-existent cluster is silently ignored.
:param contactData:
:param clusters: List of cluster names to remove.
:param groups: List of group names to remove.
:return: Modified contacts.
"""
def removeCluster( clusterName ) :
"""
Remove cluster from contacts data.
:param clusterName:
"""
nonlocal contactData
if thisCluster in contactData.clusters :
del contactData.clusters[ clusterName ]
log.info( 'Removed cluster, {0}'.format( clusterName ) )
else :
log.warning( 'Cannot remove a cluster that does not exist, {0}'.format( clusterName ) )
def removeGroupsFromCluster( clusterName, groupList ) :
nonlocal contactData
removedFromGroups = False
for thisGroup in groupList :
if thisGroup in contactData.clusters[ clusterName ] :
contactData.clusters[ clusterName ].remove( thisGroup )
removedFromGroups = True
if removedFromGroups:
log.info( 'Removed group(s) from cluster, {0}, {1}'.format( clusterName, groupList ) )
for thisCluster in clusters :
if not groups :
removeCluster( thisCluster )
else :
removeGroupsFromCluster( thisCluster, groups )
contactData.validate()
return contactData
PK ljM K . contactList/contacts/cluster/tests/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
PK ljML < contactList/contacts/cluster/tests/testContactsAddCluster.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test contacts cluster add operation.
"""
import unittest.mock
from ..operation import \
ContactData, \
add
# DO NOT DELETE! Use by unittest.mock below
import contactList.contacts.contact
class TestContactsAddCluster( unittest.TestCase ) :
"""
Test contacts cluster add operation.
"""
def setUp( self ) :
self.contacts = ContactData()
def testSingleCluster( self ) :
"""
Adding a single cluster results in the cluster being added.
"""
clustersToAdd = [ 'someName' ]
self.assertEqual( 0, len( self.contacts.clusters ) )
contactsResult = add( self.contacts, clustersToAdd )
self.assertEqual( 1, len( contactsResult.clusters ) )
self.assertEqual( set(clustersToAdd), contactsResult.clusters.keys() )
def testMultipleClusters( self ) :
"""
Adding multiple clusters results in the clusters being added.
"""
clustersToAdd = [ 'someName', 'otherName' ]
self.assertEqual( 0, len( self.contacts.clusters ) )
contactsResult = add( self.contacts, clustersToAdd )
self.assertEqual( 2, len( contactsResult.clusters ) )
self.assertEqual( set( clustersToAdd ), contactsResult.clusters.keys() )
def testMixedClusters( self ) :
"""
Adding a combination of clusters that exist and don't results in the non-existent clusters being added and
the existing clusters being ignored.
"""
clustersToAdd = [ 'someName', 'otherName' ]
self.contacts.clusters[ 'otherName' ] = list()
self.assertEqual( 1, len( self.contacts.clusters ) )
contactsResult = add( self.contacts, clustersToAdd )
self.assertEqual( 2, len( contactsResult.clusters ) )
self.assertEqual( set( clustersToAdd ), contactsResult.clusters.keys() )
def testNoClustersExistingGroupNoChange( self ) :
"""
Adding an existing cluster with content silently makes no change to the existing cluster (no error).
"""
clustersToAdd = [ 'someName' ]
expectedClusterContents = [ 'g1', 'g2' ]
self.contacts.clusters[ clustersToAdd[ 0 ] ] = expectedClusterContents
self.assertEqual( 1, len( self.contacts.clusters ) )
# mock validate method because we are deliberately using invalid contacts data.
with unittest.mock.patch.object( contactList.contacts.contact.ContactData, 'validate' ) as mockValidate :
mockValidate.return_value = None
contactsResult = add( self.contacts, clustersToAdd )
self.assertEqual( 1, len( contactsResult.clusters ) )
self.assertIn( clustersToAdd[ 0 ], contactsResult.clusters )
self.assertEqual( expectedClusterContents, contactsResult.clusters[ clustersToAdd[ 0 ] ] )
if __name__ == '__main__' :
unittest.main()
PK ljM~w w ? contactList/contacts/cluster/tests/testContactsRemoveCluster.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test contacts cluster remove operation.
"""
import unittest.mock
from ..operation import \
ContactData, \
remove
import contactList.contacts.contact
class TestContactsRemoveCluster( unittest.TestCase ) :
"""
Test contacts cluster remove operation.
"""
def setUp( self ) :
self.contacts = ContactData()
self.contacts.clusters[ 'otherName' ] = [
'g1', 'g2',
]
def testRemoveSingleCluster( self ) :
"""
Removing an existing cluster removes the cluster and doesn't affect any other clusters.
"""
clustersToRemove = [ 'someName' ]
self.contacts.clusters[ 'someName' ] = [
'g1', 'g2',
]
self.assertEqual( 2, len( self.contacts.clusters ) )
self.assertIn( clustersToRemove[ 0 ], self.contacts.clusters )
# disable validation because we don't care about group validity in this case.
with unittest.mock.patch.object( contactList.contacts.contact.ContactData, 'validate',
return_value = None ) :
contactsResult = remove( self.contacts, clustersToRemove )
self.assertEqual( 1, len( contactsResult.clusters ) )
self.assertIn( 'otherName', self.contacts.clusters )
self.assertEqual( { 'g1', 'g2' }, set( self.contacts.clusters[ 'otherName' ] ) )
def testRemoveMultipleClusters( self ) :
"""
Removing multiple clusters removes them and doesn't affect any other clusters.
"""
clustersToRemove = [ 'someName', 'otherName' ]
self.contacts.clusters[ 'another' ] = [
'g3', 'g4',
]
self.contacts.clusters[ 'someName' ] = [
'g5', 'g6',
]
self.assertEqual( 3, len( self.contacts.clusters ) )
self.assertEqual( set( clustersToRemove + [ 'another' ] ), self.contacts.clusters.keys() )
# disable validation because we don't care about group validity in this case.
with unittest.mock.patch.object( contactList.contacts.contact.ContactData, 'validate',
return_value = None ) :
contactsResult = remove( self.contacts, clustersToRemove )
self.assertEqual( 1, len( contactsResult.clusters ) )
self.assertIn( 'another', self.contacts.clusters )
self.assertEqual( { 'g3', 'g4' }, set( self.contacts.clusters[ 'another' ] ) )
def testRemoveNonExistentNoChange( self ) :
"""
Removing a non-existent module silently does nothing (no error).
"""
clustersToRemove = [ 'someName' ]
self.assertEqual( 1, len( self.contacts.clusters ) )
# disable validation because we don't care about group validity in this case.
with unittest.mock.patch.object( contactList.contacts.contact.ContactData, 'validate',
return_value = None ) :
contactsResult = remove( self.contacts, clustersToRemove )
self.assertEqual( 1, len( contactsResult.clusters ) )
class TestContactsRemoveGroupFromClusters( unittest.TestCase ) :
"""
Test contacts remove group from clusters operation.
"""
def setUp( self ) :
self.contacts = ContactData()
def testRemoveFromSingleCluster( self ) :
"""
Specifying one cluster means to remove the group(s) from those clusters.
"""
clustersToModify = [ 'c1' ]
groupsToRemove = [ 'g1', 'g2' ]
self.contacts.clusters = {
'c1' : [ 'g1', 'g2' ],
'c2' : [ 'g1', 'g3' ],
}
self.contacts.groups = {
'g1' : [ 'a', 'b' ],
'g2' : [ 'c', 'd' ],
'g3' : [ 'e', 'f' ],
}
self.assertEqual( 2, len( self.contacts.clusters ) )
self.assertEqual( 3, len( self.contacts.groups ) )
remove( self.contacts, clustersToModify, groupsToRemove )
self.assertEqual( 2, len( self.contacts.clusters ) )
self.assertEqual( 3, len( self.contacts.groups ) )
# group g1 is unchanged
self.assertEqual( [ 'a', 'b' ], self.contacts.groups['g1'] )
# group g2 is unchanged
self.assertEqual( [ 'c', 'd' ], self.contacts.groups['g2'] )
# cluster c1 is changed
self.assertEqual( list(), self.contacts.clusters[ 'c1' ] )
# cluster c2 is unchanged
self.assertEqual( [ 'g1', 'g3' ], self.contacts.clusters[ 'c2' ] )
def testRemoveFromMultipleClusters( self ) :
"""
Removing groups from multiple clusters removes the groups from those clusters. Groups not in a cluster are
silently ignored.
"""
clustersToModify = [ 'c1', 'c2' ]
groupsToRemove = [ 'g1', 'g2' ]
self.contacts.clusters = {
'c1' : [ 'g1', 'g2' ],
'c2' : [ 'g1', 'g3' ],
}
self.contacts.groups = {
'g1' : [ 'a', 'b' ],
'g2' : [ 'c', 'd' ],
'g3' : [ 'e', 'f' ],
}
self.assertEqual( 2, len( self.contacts.clusters ) )
self.assertEqual( 3, len( self.contacts.groups ) )
remove( self.contacts, clustersToModify, groupsToRemove )
self.assertEqual( 2, len( self.contacts.clusters ) )
self.assertEqual( 3, len( self.contacts.groups ) )
# group g1 is unchanged
self.assertEqual( [ 'a', 'b' ], self.contacts.groups['g1'] )
# group g2 is unchanged
self.assertEqual( [ 'c', 'd' ], self.contacts.groups['g2'] )
# cluster c1 is changed
self.assertEqual( list(), self.contacts.clusters[ 'c1' ] )
# cluster c2 is changed
self.assertEqual( [ 'g3' ], self.contacts.clusters[ 'c2' ] )
if __name__ == '__main__' :
unittest.main()
PK ljM` & contactList/contacts/email/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Manage email properties in a contacts list.
"""
from .operation import EmailOperation
PK ljMs
' contactList/contacts/email/operation.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Manage email properties in a contacts list.
"""
import logging
from contactList.arguments import ContactsOptions
from ..base import \
ContactData, \
OperationInterface
log = logging.getLogger( __name__ )
class EmailOperation( OperationInterface ) :
"""
Manage email properties in a contacts list.
"""
def __init__( self ) :
self.commands = {
'add' : {
'alias': 'add',
'args' : extractArguments,
'operation' : add,
},
'rm' : {
'alias':'remove',
'args' : extractArguments,
'operation' : remove,
},
}
def applyOperation( self, contactData: ContactData, contactsOptions: ContactsOptions ) :
"""
Redirect the command line subcommand to the specific requested subcommand to take group related actions on
contacts data.
:param contactData:
:param contactsOptions:
"""
emailCommand = contactsOptions.emailCommand
(args, kwargs) = self.commands[ emailCommand ][ 'args' ]( contactData, contactsOptions )
self.commands[ emailCommand ][ 'operation' ]( *args, **kwargs )
def extractArguments( contactData: ContactData, contactsOptions: ContactsOptions ) :
args = [
contactData,
contactsOptions.email,
]
kwargs = {
'groups' : contactsOptions.groups,
}
return args, kwargs
def add( contactData: ContactData, emails: list,
groups: list = None ) -> ContactData :
"""
Add an email to one or more groups. Add to all groups by specifying an empty group list.
Adding an existing email is ignored.
:param contactData:
:param emails: List of emails to be added.
:param groups: List of groups to add to.
:return: Modified contacts.
"""
for thisGroup in contactData.groups :
if (not groups) or (thisGroup in groups) :
for thisEmail in emails :
if thisEmail not in contactData.groups[ thisGroup ]:
contactData.groups[ thisGroup ].append( thisEmail )
log.info( 'Added email to group, {0}, {1}'.format( thisEmail, thisGroup ) )
contactData.validate()
return contactData
def remove( contactData: ContactData, emails: list,
groups: list = None ) -> ContactData :
"""
Remove an email from one or more groups. Remove from all groups by specifying an empty group list.
Removing a non-existent email is ignored.
:param contactData:
:param emails: List of emails to be added.
:param groups: List of groups to add to.
:return: Modified contacts.
"""
for thisGroup in contactData.groups.keys() :
if (not groups) or (thisGroup in groups) :
for thisEmail in emails :
contactData.groups[ thisGroup ].remove( thisEmail )
log.info( 'Removed email from group, {0}, {1}'.format( thisEmail, thisGroup ) )
contactData.validate()
return contactData
PK ljM K , contactList/contacts/email/tests/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
PK ljM 8 contactList/contacts/email/tests/testContactsAddEmail.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test contacts email add operation.
"""
import unittest.mock
from ..operation import \
ContactData, \
add
class TestContactsAddEmail( unittest.TestCase ) :
"""
Test contacts email add operation.
"""
def setUp( self ) :
self.emailsToAdd = [ 'e@f', 'g@h' ]
self.contacts = ContactData()
self.contacts.groups = {
'g1' : [
'a@b',
],
'g2' : [
'c@d',
'i@j',
],
}
def testAddEmailAllGroups( self ) :
"""
Adding an email to all groups adds the email to all groups.
"""
expectedGroups = {
'g1' : self.contacts.groups[ 'g1' ] + self.emailsToAdd,
'g2' : self.contacts.groups[ 'g2' ] + self.emailsToAdd,
}
contactsResult = add( self.contacts, self.emailsToAdd )
self.assertEqual( expectedGroups, contactsResult.groups )
def testAddEmailSpecificGroups( self ) :
"""
Adding an email to specific groups only adds the email to those groups.
"""
groupsToAdd = [ 'g2' ]
expectedGroups = {
'g1' : self.contacts.groups[ 'g1' ],
'g2' : self.contacts.groups[ 'g2' ] + self.emailsToAdd,
}
contactsResult = add( self.contacts, self.emailsToAdd,
groups = groupsToAdd )
self.assertEqual( expectedGroups, contactsResult.groups )
def testAddExistingEmail( self ) :
"""
Adding an existing email is silently ignored.
"""
emailsToAdd = [ 'c@d' ]
expectedGroups = self.contacts.groups
contactsResult = add( self.contacts, emailsToAdd )
self.assertEqual( expectedGroups, contactsResult.groups )
def testAddExistingEmailSomeGroups( self ) :
"""
Adding an email that exists in some groups but not all adds the email to the groups where it is missing.
"""
emailsToAdd = [ 'c@d' ]
expectedGroups = {
'g1' : self.contacts.groups[ 'g1' ] + emailsToAdd,
'g2' : self.contacts.groups[ 'g2' ],
}
contactsResult = add( self.contacts, emailsToAdd )
self.assertEqual( expectedGroups, contactsResult.groups )
def testMultipleAddsDoesNothing( self ) :
"""
Adding the same email multiple times has no effect..
"""
emailsToAdd = [ 'c@d' ]
groups = [ 'g1' ]
expectedGroups = {
'g1' : [
'a@b',
'c@d',
],
'g2' : [
'c@d',
'i@j',
],
}
interimResult = add( self.contacts, emailsToAdd,
groups = groups )
contactsResult = add( interimResult, emailsToAdd,
groups = groups )
self.assertEqual( expectedGroups, contactsResult.groups )
if __name__ == '__main__' :
unittest.main()
PK ljM}w
; contactList/contacts/email/tests/testContactsRemoveEmail.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test contacts email remove operation.
"""
import unittest.mock
from ..operation import \
ContactData, \
remove
class TestContactsRemoveEmail( unittest.TestCase ) :
"""
Test contacts email remove operation.
"""
def setUp( self ) :
self.contacts = ContactData()
def testRemoveFromSingleGroup( self ) :
"""
Specify a single group and only that group has the email removed.
"""
groups = [ 'g1' ]
emailsToRemove = [ 'a@b' ]
self.assertEqual( 0, len( self.contacts.clusters ) )
self.assertEqual( 0, len( self.contacts.groups ) )
self.contacts.groups = {
'g1' : [ 'a@b', 'c@d' ],
'g2' : [ 'e@f', 'a@b' ],
}
self.assertEqual( 2, len( self.contacts.groups[ 'g1' ] ) )
remove( self.contacts, emailsToRemove, groups )
self.assertEqual( 1, len( self.contacts.groups[ 'g1' ] ) )
self.assertEqual( [ 'c@d' ], self.contacts.groups[ 'g1' ] )
self.assertEqual( 2, len( self.contacts.groups[ 'g2' ] ) )
self.assertEqual( [ 'e@f', 'a@b' ], self.contacts.groups[ 'g2' ] )
def testRemoveFromAllGroups( self ) :
"""
Empty groups option (default) implies remove the email from all groups.
"""
self.assertEqual( 0, len( self.contacts.clusters ) )
self.assertEqual( 0, len( self.contacts.groups ) )
emailsToRemove = [ 'a@b' ]
self.contacts.groups = {
'g1' : [ 'a@b', 'c@d' ],
'g2' : [ 'e@f', 'a@b' ],
}
self.assertEqual( 2, len( self.contacts.groups[ 'g1' ] ) )
self.assertEqual( 2, len( self.contacts.groups[ 'g2' ] ) )
remove( self.contacts, emailsToRemove )
self.assertEqual( 1, len( self.contacts.groups[ 'g1' ] ) )
self.assertEqual( [ 'c@d' ], self.contacts.groups[ 'g1' ] )
self.assertEqual( 1, len( self.contacts.groups[ 'g2' ] ) )
self.assertEqual( [ 'e@f' ], self.contacts.groups[ 'g2' ] )
if __name__ == '__main__' :
unittest.main()
PK ljM%y & contactList/contacts/group/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Manage group properties in a contacts list.
"""
from .operation import GroupOperation
PK ljM-R ' contactList/contacts/group/operation.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Manage group properties in a contacts list.
"""
import logging
from contactList.arguments import ContactsOptions
from ..base import \
ContactData, \
ContactsOperationError, \
OperationInterface
log = logging.getLogger( __name__ )
class GroupOperation( OperationInterface ) :
"""
Manage group properties in a contacts list.
"""
def __init__( self ) :
self.commands = {
'add' : {
'args' : extractAddArguments,
'operation' : add,
},
'rm' : {
'args' : extractRemoveArguments,
'operation' : remove,
},
}
def applyOperation( self, contactData: ContactData, contactsOptions: ContactsOptions ) :
"""
Redirect the command line subcommand to the specific requested subcommand to take group related actions on
contacts data.
:param contactData:
:param contactsOptions:
"""
groupCommand = contactsOptions.groupCommand
(args, kwargs) = self.commands[ groupCommand ][ 'args' ]( contactData, contactsOptions )
self.commands[ groupCommand ][ 'operation' ]( *args, **kwargs )
def extractAddArguments( contactData: ContactData, contactsOptions: ContactsOptions ) :
args = [
contactData,
contactsOptions.group,
]
kwargs = {
'clusters' : contactsOptions.clusters,
}
return args, kwargs
def extractRemoveArguments( contactData: ContactData, contactsOptions: ContactsOptions ) :
args = [
contactData,
contactsOptions.group,
]
kwargs = {
'clusters' : contactsOptions.clusters,
}
return args, kwargs
def add( contactData: ContactData, groups: list,
clusters: list = None ) :
"""
Add a list of groups to one or more clusters. Add to all clusters by specifying an empty cluster list.
Adding an existing group doesn't change the group, but it will be added to any specified clusters.
Specify an empty cluster list to create groups without adding them to any clusters.
:param contactData:
:param groups: List of groups to add.
:param clusters: List of clusters to add the new groups to.
:return: Modified contacts.
"""
def addGroup( groupName ) :
nonlocal contactData
if thisGroup not in contactData.groups :
contactData.groups[ groupName ] = list()
log.info( 'Added new group, {0}'.format( groupName ) )
def addGroupToClusters( groupName ) :
nonlocal clusters, contactData
if clusters is None :
# Add group to all clusters.
clusters = contactData.clusters.keys()
addedToClusters = False
for thisCluster in clusters :
if thisCluster not in contactData.clusters :
# Silently create the cluster
contactData.clusters[ thisCluster ] = list()
log.info( 'Created new cluster, {0}'.format( thisCluster ) )
if groupName not in contactData.clusters[ thisCluster ] :
contactData.clusters[ thisCluster ].append( groupName )
addedToClusters = True
if addedToClusters :
log.info( 'Added group to clusters, {0}, {1}'.format( groupName, clusters ) )
for thisGroup in groups :
addGroup( thisGroup )
addGroupToClusters( thisGroup )
contactData.validate()
return contactData
def remove( contactData: ContactData, groups: list,
clusters: list = None ) :
"""
Remove a list of groups.
Exception raised if groups are members of clusters.
:param contactData:
:param groups: List of groups to add.
:param clusters: List of clusters to add the new groups to.
:return: Modified contacts.
"""
def checkGroupsAreClusterMembers() :
"""
Check if the groups are members of any cluster.
:return: True if the groups are members of any cluster.
"""
nonlocal contactData, groups
groupIsMemberOfCluster = list()
for thisGroup in groups :
clusterMembers = [ x for x, y in contactData.clusters.items() if thisGroup in y ]
if clusterMembers :
log.error( 'Group cannot be removed while it is a member of clusters, {0}, {1}'.format( thisGroup,
clusterMembers ) )
groupIsMemberOfCluster.append( bool( clusterMembers ) )
if any( groupIsMemberOfCluster ) :
raise ContactsOperationError( 'Remove group(s) from clusters before removing the group(s). Check '
'logging for details.' )
def modifyClusters( groupName ) :
nonlocal clusters, contactData
modifiedCluster = False
for thisCluster, clusterGroups in contactData.clusters.items() :
if thisGroup in clusterGroups :
clusterGroups.remove( thisGroup )
modifiedCluster = True
if modifiedCluster :
log.info( 'Removed group from clusters, {0}, {1}'.format( groupName, clusters ) )
def removeGroup( groupName ) :
nonlocal contactData
if thisGroup in contactData.groups :
del contactData.groups[ groupName ]
else :
log.debug( 'Attempt to remove non-existent group, {0}'.format( thisGroup ) )
for thisGroup in groups :
if not clusters :
checkGroupsAreClusterMembers()
removeGroup( thisGroup )
log.info( 'Removed group {0}'.format( thisGroup ) )
else :
modifyClusters( thisGroup )
contactData.validate()
return contactData
PK ljM K , contactList/contacts/group/tests/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
PK ljMZ Z 8 contactList/contacts/group/tests/testContactsAddGroup.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test contacts group add operation.
"""
import unittest.mock
from ..operation import \
ContactData, \
add
class TestContactsAddGroup( unittest.TestCase ) :
"""
Test contacts group add operation creating groups.
"""
def setUp( self ) :
self.contacts = ContactData()
def testSingleGroupEmptyClusters( self ) :
"""
Adding a group that doesn't exist adds the group, and if there are no clusters there is no change to the
clusters.
"""
self.assertEqual( 0, len( self.contacts.groups ) )
self.assertEqual( 0, len( self.contacts.clusters ) )
groupsToAdd = [ 'someName' ]
add( self.contacts, groupsToAdd )
self.assertEqual( 1, len( self.contacts.groups ) )
self.assertIn( groupsToAdd[ 0 ], self.contacts.groups )
self.assertEqual( 0, len( self.contacts.clusters ) )
def testNoGroupsExistingGroupNoChange( self ) :
"""
Adding an existing group makes no change to the group.
"""
self.assertEqual( 0, len( self.contacts.groups ) )
self.assertEqual( 0, len( self.contacts.clusters ) )
groupsToAdd = [ 'someName' ]
expectedGroupContents = [ 'a@b', 'c@d' ]
self.contacts.groups[ groupsToAdd[ 0 ] ] = expectedGroupContents
self.assertEqual( 1, len( self.contacts.groups ) )
add( self.contacts, groupsToAdd )
self.assertEqual( 1, len( self.contacts.groups ) )
self.assertIn( groupsToAdd[ 0 ], self.contacts.groups )
self.assertEqual( expectedGroupContents, self.contacts.groups[ groupsToAdd[ 0 ] ] )
self.assertEqual( 0, len( self.contacts.clusters ) )
class TestContactsGroupAddClusters( unittest.TestCase ) :
"""
Test contacts group add operation adding to clusters.
"""
def setUp( self ) :
self.contacts = ContactData()
self.contacts.groups = {
'g1' : [ 'a@b', 'c@d' ],
'g2' : [ 'e@f', 'a@b' ],
'g3' : [ 'a@b', 'c@d', 'e@f' ],
}
self.contacts.clusters = {
'c1' : [ 'g3' ],
'c2' : [ 'g2' ],
}
def testSingleClusterSpecified( self ) :
"""
Specifying a cluster that exists to add the group to adds only to that group.
"""
self.assertEqual( 1, len( self.contacts.clusters[ 'c1' ] ) )
self.assertEqual( 1, len( self.contacts.clusters[ 'c2' ] ) )
groupsToAdd = [ 'g1' ]
clustersToAdd = [ 'c2' ]
add( self.contacts, groupsToAdd,
clusters = clustersToAdd )
self.assertEqual( 1, len( self.contacts.clusters[ 'c1' ] ) )
self.assertEqual( 2, len( self.contacts.clusters[ 'c2' ] ) )
self.assertEqual( [ 'g2', 'g1' ], self.contacts.clusters[ 'c2' ] )
def testExistingClusterNoChange( self ) :
"""
Specifying a cluster that already contains the group doesn't change the cluster.
"""
self.assertEqual( 1, len( self.contacts.clusters[ 'c1' ] ) )
self.assertEqual( 1, len( self.contacts.clusters[ 'c2' ] ) )
groupsToAdd = [ 'g2' ]
clustersToAdd = [ 'c2' ]
add( self.contacts, groupsToAdd,
clusters = clustersToAdd )
self.assertEqual( 1, len( self.contacts.clusters[ 'c1' ] ) )
self.assertEqual( 1, len( self.contacts.clusters[ 'c2' ] ) )
self.assertEqual( [ 'g2' ], self.contacts.clusters[ 'c2' ] )
def testMultipleClustersSpecified( self ) :
"""
Specifying multiple clusters adds the group to all specified clusters.
"""
self.contacts.clusters[ 'c3' ] = list()
groupsToAdd = [ 'g1' ]
clustersToAdd = [ 'c3', 'c2' ]
add( self.contacts, groupsToAdd,
clusters = clustersToAdd )
self.assertEqual( 1, len( self.contacts.clusters[ 'c1' ] ) )
self.assertEqual( [ 'g3' ], self.contacts.clusters[ 'c1' ] )
self.assertEqual( 2, len( self.contacts.clusters[ 'c2' ] ) )
self.assertEqual( [ 'g2', 'g1' ], self.contacts.clusters[ 'c2' ] )
self.assertEqual( 1, len( self.contacts.clusters[ 'c3' ] ) )
self.assertEqual( [ 'g1' ], self.contacts.clusters[ 'c3' ] )
def testAllClustersSpecified( self ) :
"""
Specifying ``None`` clusters (default) adds group to all clusters.
"""
self.assertEqual( 1, len( self.contacts.clusters[ 'c1' ] ) )
self.assertEqual( 1, len( self.contacts.clusters[ 'c2' ] ) )
groupsToAdd = [ 'g1' ]
add( self.contacts, groupsToAdd )
self.assertEqual( 2, len( self.contacts.clusters[ 'c1' ] ) )
self.assertEqual( [ 'g3', 'g1' ], self.contacts.clusters[ 'c1' ] )
self.assertEqual( 2, len( self.contacts.clusters[ 'c2' ] ) )
self.assertEqual( [ 'g2', 'g1' ], self.contacts.clusters[ 'c2' ] )
if __name__ == '__main__' :
unittest.main()
PK ljM5cM ; contactList/contacts/group/tests/testContactsRemoveGroup.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test contacts group remove operation.
"""
import unittest.mock
from ..operation import \
ContactData, \
ContactsOperationError, \
remove
class TestContactsRemoveGroup( unittest.TestCase ) :
"""
Test basic contacts group remove operation.
"""
def setUp( self ) :
self.contacts = ContactData()
self.contacts.groups = {
'g1' : [ 'a@b', 'c@d' ],
'g2' : [ 'e@f', 'g@h' ],
'g3' : [ 'i@j', 'k@l' ],
}
def testSingleGroup( self ) :
"""
Removing a single group removes the group and leaves other groups untouched.
"""
groupsToRemove = [ 'g1' ]
self.assertEqual( 0, len( self.contacts.clusters ) )
self.assertEqual( 3, len( self.contacts.groups ) )
contactsResult = remove( self.contacts, groupsToRemove )
self.assertEqual( 0, len( contactsResult.clusters ) )
self.assertEqual( 2, len( contactsResult.groups ) )
self.assertEqual( { 'g2', 'g3' }, contactsResult.groups.keys() )
self.assertEqual( [ 'e@f', 'g@h' ], contactsResult.groups[ 'g2' ] )
self.assertEqual( [ 'i@j', 'k@l' ], contactsResult.groups[ 'g3' ] )
def testMultipleGroups( self ) :
"""
Specifying an array of group names removes each group.
"""
groupsToRemove = [ 'g1', 'g3' ]
self.assertEqual( 0, len( self.contacts.clusters ) )
self.assertEqual( 3, len( self.contacts.groups ) )
contactsResult = remove( self.contacts, groupsToRemove )
self.assertEqual( 0, len( contactsResult.clusters ) )
self.assertEqual( 1, len( contactsResult.groups ) )
self.assertIn( 'g2', contactsResult.groups )
self.assertEqual( [ 'e@f', 'g@h' ], contactsResult.groups[ 'g2' ] )
def testGroupsClusterMembersRaises( self ) :
"""
Exception raised if the group being removed is still a member of any clusters.
"""
groupsToRemove = [ 'g1', 'g3' ]
# Create a cluster with an existing group as a member.
self.contacts.clusters = {
'c1' : [ 'g3' ],
}
self.assertEqual( 1, len( self.contacts.clusters ) )
self.assertEqual( 3, len( self.contacts.groups ) )
with self.assertRaisesRegex( ContactsOperationError, '^Remove group\(s\) from clusters before removing the '
'group\(s\)' ) :
remove( self.contacts, groupsToRemove )
def testModifyClusters( self ) :
"""
Specifying an array of clusters with an array of groups removes each group from each cluster,
silently ignoring missing groups.
"""
groupsToModify = [ 'g1', 'g3' ]
clustersToModify = [ 'c1' ]
self.contacts.clusters = {
'c1' : [ 'g1', 'g2', 'g3' ],
'c2' : [ 'g2' ],
}
self.assertEqual( 2, len( self.contacts.clusters ) )
self.assertEqual( 3, len( self.contacts.groups ) )
contactsResult = remove( self.contacts, groupsToModify,
clusters = clustersToModify )
self.assertNotIn( 'g1', contactsResult.clusters[ 'c1' ] )
self.assertNotIn( 'g3', contactsResult.clusters[ 'c1' ] )
self.assertIn( 'g2', contactsResult.clusters[ 'c1' ] )
self.assertIn( 'g2', contactsResult.groups )
self.assertIn( 'g3', contactsResult.groups )
if __name__ == '__main__' :
unittest.main()
PK ljM K & contactList/contacts/tests/__init__.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
PK ljMlz z * contactList/contacts/tests/testContacts.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
High level integration tests of contacts operations with contacts data.
"""
import unittest.mock
from ..contact import \
Contacts, \
ContactsOptions
class TestContacts( unittest.TestCase ) :
"""
Test high level contacts instantiation.
"""
def testEmptyContacts( self ) :
contactsUnderTest = Contacts()
self.assertEqual( dict(), contactsUnderTest.data.clusters )
self.assertEqual( dict(), contactsUnderTest.data.groups )
class TestGroupAdd( unittest.TestCase ) :
"""
Test integration of group add command.
"""
def setUp( self ) :
self.contactsUnderTest = Contacts()
self.mockOptions = unittest.mock.create_autospec( ContactsOptions )
self.mockOptions.activeSubcommand = 'group'
self.mockOptions.clusters = list()
def testAddGroups( self ) :
self.mockOptions.groupCommand = 'add'
self.assertEqual( 0, len( self.contactsUnderTest.data.clusters ) )
self.assertEqual( 0, len( self.contactsUnderTest.data.groups ) )
self.mockOptions.group = [ 'g1', 'g2' ]
self.contactsUnderTest.applyAction( self.mockOptions )
self.assertEqual( 0, len( self.contactsUnderTest.data.clusters ) )
self.assertEqual( 2, len( self.contactsUnderTest.data.groups ) )
self.assertEqual( set( self.mockOptions.group ), self.contactsUnderTest.data.groups.keys() )
class TestGroupRemove( unittest.TestCase ) :
"""
Test integration of group remove command.
"""
def setUp( self ) :
self.contactsUnderTest = Contacts()
# Add some groups to work with
self.contactsUnderTest.data.groups = {
'g1' : list(),
'g2' : list(),
}
self.mockOptions = unittest.mock.create_autospec( ContactsOptions )
self.mockOptions.activeSubcommand = 'group'
self.mockOptions.clusters = list()
self.assertEqual( 0, len( self.contactsUnderTest.data.clusters ) )
self.assertEqual( 2, len( self.contactsUnderTest.data.groups ) )
def testRemoveGroups( self ) :
self.mockOptions.groupCommand = 'rm'
self.mockOptions.group = [ 'g1', 'g2' ]
self.contactsUnderTest.applyAction( self.mockOptions )
self.assertEqual( 0, len( self.contactsUnderTest.data.clusters ) )
self.assertEqual( 0, len( self.contactsUnderTest.data.groups ) )
class TestClusterAdd( unittest.TestCase ) :
"""
Test integration of cluster add command.
"""
def setUp( self ) :
self.contactsUnderTest = Contacts()
self.mockOptions = unittest.mock.create_autospec( ContactsOptions )
self.mockOptions = unittest.mock.create_autospec( ContactsOptions )
self.mockOptions.activeSubcommand = 'cluster'
self.mockOptions.clusters = list()
def testAddCluster( self ) :
self.mockOptions.clusterCommand = 'add'
self.assertEqual( 0, len( self.contactsUnderTest.data.clusters ) )
self.assertEqual( 0, len( self.contactsUnderTest.data.groups ) )
self.mockOptions.cluster = [ 'c1', 'c2' ]
self.contactsUnderTest.applyAction( self.mockOptions )
self.assertEqual( 2, len( self.contactsUnderTest.data.clusters ) )
self.assertEqual( 0, len( self.contactsUnderTest.data.groups ) )
self.assertEqual( set( self.mockOptions.cluster ), self.contactsUnderTest.data.clusters.keys() )
class TestClusterRemove( unittest.TestCase ) :
"""
Test integration of cluster remove command.
"""
def setUp( self ) :
self.contactsUnderTest = Contacts()
# Add some clusters to work with
self.contactsUnderTest.data.clusters = {
'c1' : list(),
'c2' : list(),
}
self.mockOptions = unittest.mock.create_autospec( ContactsOptions )
self.mockOptions.activeSubcommand = 'cluster'
self.mockOptions.cluster = list()
self.mockOptions.groups = None
self.assertEqual( 2, len( self.contactsUnderTest.data.clusters ) )
self.assertEqual( 0, len( self.contactsUnderTest.data.groups ) )
def testRemoveClusters( self ) :
self.mockOptions.clusterCommand = 'rm'
self.mockOptions.cluster = [ 'c1', 'c2' ]
self.contactsUnderTest.applyAction( self.mockOptions )
self.assertEqual( 0, len( self.contactsUnderTest.data.clusters ) )
self.assertEqual( 0, len( self.contactsUnderTest.data.groups ) )
class TestEmailAdd( unittest.TestCase ) :
"""
Test integration of email add command.
"""
def setUp( self ) :
self.contactsUnderTest = Contacts()
# Add some groups to work with
self.contactsUnderTest.data.groups = {
'g1' : list(),
'g2' : list(),
}
self.mockOptions = unittest.mock.create_autospec( ContactsOptions )
self.mockOptions = unittest.mock.create_autospec( ContactsOptions )
self.mockOptions.activeSubcommand = 'email'
self.mockOptions.groups = list()
self.assertEqual( 0, len( self.contactsUnderTest.data.clusters ) )
self.assertEqual( 2, len( self.contactsUnderTest.data.groups ) )
def testAddEmails( self ) :
self.mockOptions.emailCommand = 'add'
self.mockOptions.email = [ 'a@b', 'c@d' ]
self.mockOptions.groups = [ 'g1', 'g2' ]
self.contactsUnderTest.applyAction( self.mockOptions )
self.assertEqual( 0, len( self.contactsUnderTest.data.clusters ) )
self.assertEqual( 2, len( self.contactsUnderTest.data.groups ) )
self.assertEqual( self.mockOptions.email, self.contactsUnderTest.data.groups[ 'g1' ] )
self.assertEqual( self.mockOptions.email, self.contactsUnderTest.data.groups[ 'g2' ] )
class TestEmailRemove( unittest.TestCase ) :
"""
Test integration of email remove command.
"""
def setUp( self ) :
self.contactsUnderTest = Contacts()
# Add some groups to work with
self.contactsUnderTest.data.groups = {
'g1' : [ 'a@b', 'c@d', ],
'g2' : [ 'c@d', 'e@f', ],
}
self.mockOptions = unittest.mock.create_autospec( ContactsOptions )
self.mockOptions = unittest.mock.create_autospec( ContactsOptions )
self.mockOptions.activeSubcommand = 'email'
self.mockOptions.groups = list()
self.assertEqual( 0, len( self.contactsUnderTest.data.clusters ) )
self.assertEqual( 2, len( self.contactsUnderTest.data.groups ) )
def testRemoveEmail( self ) :
self.mockOptions.emailCommand = 'rm'
self.mockOptions.email = [ 'c@d' ]
self.contactsUnderTest.applyAction( self.mockOptions )
self.assertEqual( 0, len( self.contactsUnderTest.data.clusters ) )
self.assertEqual( 2, len( self.contactsUnderTest.data.groups ) )
self.assertEqual( [ 'a@b' ], self.contactsUnderTest.data.groups[ 'g1' ] )
self.assertEqual( [ 'e@f' ], self.contactsUnderTest.data.groups[ 'g2' ] )
if __name__ == '__main__' :
unittest.main()
PK ljMH contactList/tests/__init__.py#
# Copyright 2018 Russell Smiley
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
PK ljMw / / ( contactList/tests/testContactsOptions.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Integration tests of command line argument parsing and contacts data.
"""
import unittest.mock
from ..contacts import \
Contacts, \
ContactsOperationError
from ..entry import main
# DO NOT DELETE! Used by unittest.mock.patch below.
import contactList
class TestClusterAddIntegration( unittest.TestCase ) :
def setUp( self ) :
self.mock_contacts = Contacts()
def testAddNewCluster( self ) :
inputValue = [
'-d',
'-f',
'some/file',
'cluster',
'add',
'myCluster',
]
with unittest.mock.patch( 'contactList.entry.Contacts.from_yamlFile',
return_value = self.mock_contacts ), \
unittest.mock.patch( 'contactList.contacts.Contacts.to_yamlFile' ) :
main( inputValue )
self.assertIn( inputValue[ 5 ], self.mock_contacts.data.clusters )
class TestClusterRemoveIntegration( unittest.TestCase ) :
def setUp( self ) :
self.mock_contacts = Contacts()
self.mock_contacts.data.clusters = {
'c1' : list(),
'c2' : list(),
}
def testRemoveExistingCluster( self ) :
inputValue = [
'-d',
'-f',
'some/file',
'cluster',
'rm',
'c1',
]
with unittest.mock.patch( 'contactList.entry.Contacts.from_yamlFile',
return_value = self.mock_contacts ), \
unittest.mock.patch( 'contactList.contacts.Contacts.to_yamlFile' ) :
main( inputValue )
self.assertNotIn( 'c1', self.mock_contacts.data.clusters )
self.assertIn( 'c2', self.mock_contacts.data.clusters )
def testRemoveExistingClusterGroupMembers( self ) :
self.mock_contacts.data.clusters = {
'c1' : [ 'g1' ],
'c2' : [ 'g2' ],
}
self.mock_contacts.data.groups = {
'g1' : [ 'a@b', 'c@d' ],
'g2' : [ 'c@d', 'e@f' ],
}
inputValue = [
'-d',
'-f',
'some/file',
'cluster',
'rm',
'c1',
]
with unittest.mock.patch( 'contactList.entry.Contacts.from_yamlFile',
return_value = self.mock_contacts ), \
unittest.mock.patch( 'contactList.contacts.Contacts.to_yamlFile' ) :
main( inputValue )
self.assertNotIn( 'c1', self.mock_contacts.data.clusters )
self.assertIn( 'c2', self.mock_contacts.data.clusters )
def testRemoveClusterGroupMember( self ) :
self.mock_contacts.data.clusters = {
'c1' : [ 'g1' ],
'c2' : [ 'g2' ],
}
self.mock_contacts.data.groups = {
'g1' : [ 'a@b', 'c@d' ],
'g2' : [ 'c@d', 'e@f' ],
}
inputValue = [
'-d',
'-f',
'some/file',
'cluster',
'rm',
'c1',
'--group',
'g1'
]
with unittest.mock.patch( 'contactList.entry.Contacts.from_yamlFile',
return_value = self.mock_contacts ), \
unittest.mock.patch( 'contactList.contacts.Contacts.to_yamlFile' ) :
main( inputValue )
self.assertEqual( list(), self.mock_contacts.data.clusters[ 'c1' ] )
self.assertIn( 'c2', self.mock_contacts.data.clusters )
def testRemoveClusterMultipleGroupMembers( self ) :
self.mock_contacts.data.clusters = {
'c1' : [ 'g1', 'g2' ],
'c2' : [ 'g2' ],
}
self.mock_contacts.data.groups = {
'g1' : [ 'a@b', 'c@d' ],
'g2' : [ 'c@d', 'e@f' ],
}
inputValue = [
'-d',
'-f',
'some/file',
'cluster',
'rm',
'c1',
'--groups',
'g1',
'g2',
]
with unittest.mock.patch( 'contactList.entry.Contacts.from_yamlFile',
return_value = self.mock_contacts ), \
unittest.mock.patch( 'contactList.contacts.Contacts.to_yamlFile' ) :
main( inputValue )
self.assertEqual( list(), self.mock_contacts.data.clusters[ 'c1' ] )
self.assertIn( 'c2', self.mock_contacts.data.clusters )
class TestEmailAddIntegration( unittest.TestCase ) :
def setUp( self ) :
self.mock_contacts = Contacts()
self.mock_contacts.data.groups = {
'g1' : list(),
'g2' : list(),
}
def testAddNewEmail( self ) :
inputValue = [
'-d',
'-f',
'some/file',
'email',
'add',
'a@b',
]
with unittest.mock.patch( 'contactList.entry.Contacts.from_yamlFile',
return_value = self.mock_contacts ), \
unittest.mock.patch( 'contactList.contacts.Contacts.to_yamlFile' ) :
main( inputValue )
self.assertEqual( [ 'a@b' ], self.mock_contacts.data.groups[ 'g1' ] )
self.assertEqual( [ 'a@b' ], self.mock_contacts.data.groups[ 'g2' ] )
class TestEmailRemoveIntegration( unittest.TestCase ) :
def setUp( self ) :
self.mock_contacts = Contacts()
self.mock_contacts.data.groups = {
'g1' : [ 'a@b' ],
'g2' : [ 'a@b', 'c@d' ],
}
def testRemoveExistingEmail( self ) :
inputValue = [
'-d',
'-f',
'some/file',
'email',
'rm',
'a@b',
]
with unittest.mock.patch( 'contactList.entry.Contacts.from_yamlFile',
return_value = self.mock_contacts ), \
unittest.mock.patch( 'contactList.contacts.Contacts.to_yamlFile' ) :
main( inputValue )
self.assertEqual( list(), self.mock_contacts.data.groups[ 'g1' ] )
self.assertEqual( [ 'c@d' ], self.mock_contacts.data.groups[ 'g2' ] )
class TestGroupAddIntegration( unittest.TestCase ) :
def setUp( self ) :
self.mock_contacts = Contacts()
def testAddNewGroup( self ) :
inputValue = [
'-d',
'-f',
'some/file',
'group',
'add',
'myGroup',
]
with unittest.mock.patch( 'contactList.entry.Contacts.from_yamlFile',
return_value = self.mock_contacts ), \
unittest.mock.patch( 'contactList.contacts.Contacts.to_yamlFile' ) :
main( inputValue )
self.assertIn( inputValue[ 5 ], self.mock_contacts.data.groups )
def testAddNewGroupToNonexistentCluster( self ) :
"""
Adding a new group to a non-existent cluster implicitly creates the cluster as well as adding the group to
the cluster.
"""
inputValue = [
'-d',
'-f',
'some/file',
'group',
'add',
'myGroup',
'--cluster',
'myCluster',
]
self.assertNotIn( inputValue[ 7 ], self.mock_contacts.data.clusters )
with unittest.mock.patch( 'contactList.entry.Contacts.from_yamlFile',
return_value = self.mock_contacts ), \
unittest.mock.patch( 'contactList.contacts.Contacts.to_yamlFile' ) :
main( inputValue )
self.assertIn( inputValue[ 5 ], self.mock_contacts.data.groups )
self.assertIn( inputValue[ 7 ], self.mock_contacts.data.clusters )
self.assertIn( inputValue[ 5 ], self.mock_contacts.data.clusters[ inputValue[ 7 ] ] )
class TestGroupRemoveIntegration( unittest.TestCase ) :
def setUp( self ) :
self.mock_contacts = Contacts()
self.mock_contacts.data.clusters = dict()
self.mock_contacts.data.groups = {
'g1' : list(),
'g2' : list(),
}
def testRemoveExistingGroup( self ) :
self.assertTrue( not self.mock_contacts.data.clusters )
inputValue = [
'-d',
'-f',
'some/file',
'group',
'rm',
'g1',
]
with unittest.mock.patch( 'contactList.entry.Contacts.from_yamlFile',
return_value = self.mock_contacts ), \
unittest.mock.patch( 'contactList.contacts.Contacts.to_yamlFile' ) :
main( inputValue )
self.assertNotIn( 'g1', self.mock_contacts.data.groups )
def testRemoveGroupFromCluster( self ) :
self.mock_contacts.data.clusters = {
'c1' : [ 'g1' ],
'c2' : [ 'g2' ],
}
inputValue = [
'-d',
'-f',
'some/file',
'group',
'rm',
'g1',
'--cluster',
'c1',
]
with unittest.mock.patch( 'contactList.entry.Contacts.from_yamlFile',
return_value = self.mock_contacts ), \
unittest.mock.patch( 'contactList.contacts.Contacts.to_yamlFile' ) :
main( inputValue )
self.assertIn( 'g1', self.mock_contacts.data.groups )
self.assertNotIn( 'g1', self.mock_contacts.data.clusters[ 'c1' ] )
def testRemoveGroupFromMultipleClusters( self ) :
self.mock_contacts.data.clusters = {
'c1' : [ 'g1' ],
'c2' : [ 'g2', 'g1' ],
}
inputValue = [
'-d',
'-f',
'some/file',
'group',
'rm',
'g1',
'--clusters',
'c1',
'c2',
]
with unittest.mock.patch( 'contactList.entry.Contacts.from_yamlFile',
return_value = self.mock_contacts ), \
unittest.mock.patch( 'contactList.contacts.Contacts.to_yamlFile' ) :
main( inputValue )
self.assertIn( 'g1', self.mock_contacts.data.groups )
self.assertNotIn( 'g1', self.mock_contacts.data.clusters[ 'c1' ] )
self.assertNotIn( 'g1', self.mock_contacts.data.clusters[ 'c2' ] )
def testRemoveExistingGroupClusterMemberRaises( self ) :
"""
Removing a group that is a member of a cluster removes the group and it's entry in the cluster.
"""
self.mock_contacts.data.clusters = {
'c1' : [ 'g1' ],
'c2' : [ 'g2' ],
}
inputValue = [
'-d',
'-f',
'some/file',
'group',
'rm',
'g1',
]
with unittest.mock.patch( 'contactList.entry.Contacts.from_yamlFile',
return_value = self.mock_contacts ), \
unittest.mock.patch( 'contactList.contacts.Contacts.to_yamlFile' ) :
with self.assertRaisesRegex( ContactsOperationError, '^Remove group\(s\) from clusters before removing the '
'group\(s\)' ) :
main( inputValue )
if __name__ == '__main__' :
unittest.main()
PK ljMȍ # contactList/tests/testEntrypoint.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test flit entrypoint.
"""
import io
import unittest.mock
from .utility import redirect_stdout_stderr
from ..entry import entryPoint
# DO NOT DELETE! Used unittest.mock.patch below
import contactList.entry
class TestEntrypoint( unittest.TestCase ) :
def testCatchExceptions( self ) :
"""
Exceptions are caught by the entry point and sys.exit is called.
"""
with unittest.mock.patch( 'contactList.entry.main' ) as mock_main :
# Temporarily suppress output from entry point.
f = io.StringIO()
with redirect_stdout_stderr( f ) :
entryPoint()
mock_main.assert_called_once()
if __name__ == '__main__' :
unittest.main()
PK ljM contactList/tests/testMain.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test main entry point.
"""
import io
import unittest.mock
from .utility import redirect_stdout_stderr
from ..entry import main
# DO NOT DELETE. Used by unittest.mock below.
import contactList.entry
class TestMain( unittest.TestCase ) :
"""
Test main entry point.
"""
def testArguments( self ) :
inputArguments = [
'add-cluster',
'someName',
]
mockOptions = unittest.mock.create_autospec( contactList.entry.ContactsOptions )
mockOptions.contactsFile = inputArguments[ 1 ]
mockOptions.debug = True
mockContacts = unittest.mock.create_autospec( contactList.entry.Contacts )
with unittest.mock.patch.object( contactList.entry.ContactsOptions, 'from_arguments' ) as mockFromArguments, \
unittest.mock.patch.object( contactList.entry.Contacts, 'from_yamlFile' ) as mockContactsFromYamlFile :
mockFromArguments.return_value = mockOptions
mockContactsFromYamlFile.return_value = mockContacts
main( inputArguments )
mockFromArguments.assert_called_once_with( inputArguments )
mockContactsFromYamlFile.assert_called_once_with( filename = inputArguments[ 1 ] )
mockContacts.applyAction.assert_called_once_with( mockOptions )
mockContacts.to_yamlFile.assert_called_once_with( filename = inputArguments[ 1 ] )
def mockFromYaml( *args, **kwargs ) :
raise RuntimeError( 'This is an error' )
class TestExceptionsDebug( unittest.TestCase ) :
def setUp( self ) :
self.mockOptions = unittest.mock.create_autospec( contactList.entry.ContactsOptions )
def testDisabledDebugModeCatchesExceptions( self ) :
"""
Exceptions are caught by the entry point and sys.exit is called.
"""
self.mockOptions.debug = False
with unittest.mock.patch.object( contactList.entry.ContactsOptions, 'from_arguments',
return_value = self.mockOptions ), \
unittest.mock.patch( 'contactList.entry.sys.exit' ) \
as mock_sysExit :
# Temporarily suppress output from entry point.
f = io.StringIO()
with redirect_stdout_stderr( f ) :
main( list() )
mock_sysExit.assert_called_once_with( 1 )
def testEnabledDebugModeRaises( self ) :
"""
Exceptions are caught by the entry point and sys.exit is called.
"""
self.mockOptions.debug = True
with unittest.mock.patch.object( contactList.entry.ContactsOptions, 'from_arguments',
return_value = self.mockOptions ), \
unittest.mock.patch.object( contactList.entry.Contacts, 'from_yamlFile',
side_effect = mockFromYaml ), \
unittest.mock.patch( 'contactList.entry.sys.exit' ) as mock_sysExit :
with self.assertRaises( Exception ) :
# Temporarily suppress output from entry point.
f = io.StringIO()
with redirect_stdout_stderr( f ) :
main( list() )
mock_sysExit.assert_not_called()
if __name__ == '__main__' :
unittest.main()
PK ljM* # contactList/tests/testYamlExport.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test contact data YAML export.
"""
import io
import unittest.mock
from contactList.contacts import Contacts
# DO NOT DELETE! Used by unittest.mock.patch below.
import contactList.contacts.contact
class TestContactsYamlExport( unittest.TestCase ) :
def setUp( self ) :
self.yamlData = {
'clusters' : {
'c1' : [ 'g1' ],
'c2' : [ 'g2', 'g3' ],
},
'groups' : {
'g1' : [ 'a', 'b' ],
'g2' : [ 'c', 'd' ],
'g3' : [ 'a', 'e', 'f' ],
},
}
self.contactsUnderTest = Contacts.from_yamlData( self.yamlData )
def testFileObjectSave( self ) :
with unittest.mock.patch( 'contactList.contacts.contact.yaml.dump' ) as mockYamlDump :
with io.StringIO() as fileObject :
self.contactsUnderTest.to_yamlFile( fileObject = fileObject )
mockYamlDump.assert_called_once_with( self.yamlData, fileObject )
def testFilenameSave( self ) :
expectedFilename = 'some/file.name'
# https://docs.python.org/3/library/unittest.mock.html?highlight=mock_open#unittest.mock.mock_open
mockOpen = unittest.mock.mock_open()
with unittest.mock.patch( 'contactList.contacts.contact.open', mockOpen ), \
unittest.mock.patch( 'contactList.contacts.contact.yaml.dump' ) as mockYamlDump :
self.contactsUnderTest.to_yamlFile( filename = expectedFilename )
mockOpen.assert_called_once_with( expectedFilename, 'w' )
mockFileObject = mockOpen.return_value.__enter__.return_value
mockYamlDump.assert_called_once_with( self.yamlData, mockFileObject )
def testDefaultFilenameSave( self ) :
expectedFilename = 'contacts.yml'
mockOpen = unittest.mock.mock_open()
with unittest.mock.patch( 'contactList.contacts.contact.open', mockOpen ), \
unittest.mock.patch( 'contactList.contacts.contact.yaml.dump' ) as mockYamlDump :
self.contactsUnderTest.to_yamlFile()
mockOpen.assert_called_once_with( expectedFilename, 'w' )
mockFileObject = mockOpen.return_value.__enter__.return_value
mockYamlDump.assert_called_once_with( self.yamlData, mockFileObject )
if __name__ == '__main__' :
unittest.main()
PK ljM0 # contactList/tests/testYamlImport.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Test contact data YAML import.
"""
import io
import unittest.mock
import yaml.constructor
from contactList.contacts import Contacts
# DO NOT DELETE. Used by unittest.mock below.
import contactList.contacts.contact
class TestContactsFromYamlData( unittest.TestCase ) :
"""
Test constructing contacts object from a YAML data structure.
"""
def testClusters( self ) :
yamlData = {
'clusters' : {
'one' : [ 'a', 'b' ],
'two' : [ 'c', 'd' ],
},
}
contactsUnderTest = Contacts.from_yamlData( yamlData )
self.assertIn( 'one', contactsUnderTest.data.clusters )
self.assertIn( 'two', contactsUnderTest.data.clusters )
self.assertTrue( isinstance( contactsUnderTest.data.clusters, dict ) )
def testImportEmpty( self ) :
yamlData = dict()
contactsUnderTest = Contacts.from_yamlData( yamlData )
self.assertTrue( isinstance( contactsUnderTest, Contacts ) )
self.assertEqual( dict(), contactsUnderTest.data.groups )
self.assertEqual( dict(), contactsUnderTest.data.clusters )
def testImportNone( self ) :
"""
Construct an empty contacts object for ``None`` input.
"""
yamlData = None
contactsUnderTest = Contacts.from_yamlData( yamlData )
self.assertTrue( isinstance( contactsUnderTest, Contacts ) )
self.assertEqual( dict(), contactsUnderTest.data.groups )
self.assertEqual( dict(), contactsUnderTest.data.clusters )
def testGroups( self ) :
yamlData = {
'groups' : {
'one' : [ 'a', 'b' ],
'two' : [ 'c', 'd' ],
},
}
contactsUnderTest = Contacts.from_yamlData( yamlData )
self.assertIn( 'one', contactsUnderTest.data.groups )
self.assertIn( 'two', contactsUnderTest.data.groups )
self.assertTrue( isinstance( contactsUnderTest.data.groups, dict ) )
def testGroupsOk( self ) :
yamlData = {
'clusters' : {
'c1' : [ 'g1', 'g2' ],
},
'groups' : {
'g1' : [ 'a', 'b' ],
'g2' : [ 'c', 'd' ],
},
}
contactsUnderTest = Contacts.from_yamlData( yamlData )
class TestContactsFromYamlFile( unittest.TestCase ) :
def testFilenameDefaultArgument( self ) :
yamlData = """{
'groups' : {
'one' : [ 'a', 'b' ],
'two' : [ 'c', 'd' ],
},
}"""
expectedFilename = 'someFile'
with unittest.mock.patch( 'contactList.contacts.contact.os.path.isfile',
return_value = True ), \
unittest.mock.patch( 'contactList.contacts.contact.open',
unittest.mock.mock_open( read_data = yamlData ) ) as mockOpen :
contactsUnderTest = Contacts.from_yamlFile( expectedFilename )
mockOpen.assert_called_once_with( expectedFilename, 'r' )
self.assertIn( 'one', contactsUnderTest.data.groups )
self.assertIn( 'two', contactsUnderTest.data.groups )
def testFileNotExistRaises( self ) :
"""
``FileNotFoundError`` is raised on attempting to load from a file that doesn't exist.
"""
with unittest.mock.patch( 'contactList.contacts.contact.os.path.isfile',
return_value = False ) :
with self.assertRaisesRegex( FileNotFoundError, '^File does not exist' ) :
Contacts.from_yamlFile( 'some/file' )
class TestContactSafeLoad( unittest.TestCase ) :
def setUp( self ) :
self.unsafeYamlData = """
'groups' :
'one': !!python/object:Exception
'two' : [ 'c', 'd' ]
"""
def testFileObjectLoad( self ) :
functionUnderTest = Contacts.from_yamlFile
with io.StringIO( initial_value = self.unsafeYamlData ) as fileObject :
functionArgument = { 'fileObject' : fileObject }
self.doTest( functionUnderTest, functionArgument )
def testYamlFileLoad( self ) :
expectedFilename = 'someFile.yml'
with unittest.mock.patch( 'contactList.contacts.contact.os.path.isfile',
return_value = True ), \
unittest.mock.patch( 'contactList.contacts.contact.open',
unittest.mock.mock_open( read_data = self.unsafeYamlData ) ) as mockOpen :
functionUnderTest = Contacts.from_yamlFile
functionArgument = { 'filename' : expectedFilename }
self.doTest( functionUnderTest, functionArgument )
# mock_open.assert_called_once_with( expectedFilename )
mockOpen.assert_called_once_with( expectedFilename, 'r' )
def doTest( self, functionUnderTest, functionArgument ) :
with self.assertRaises(
yaml.constructor.ConstructorError,
msg = 'could not determine a constructor for the tag ''tag:yaml.org, 2002:python/object:Exception'''
) :
functionUnderTest( **functionArgument )
if __name__ == '__main__' :
unittest.main()
PK ljMy", contactList/tests/utility.py#
# Copyright 2018 Russell Smiley
#
# This file is part of contactList.
#
# contactList is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contactList 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contactList. If not, see .
#
"""
Utilities to support tests.
"""
import sys
from contextlib import contextmanager
# Use a context manager to temporarily suppress spurious output from argparse.
# https://stackoverflow.com/questions/29935283/how-to-set-custom-output-handlers-for-argparse-in-python
@contextmanager
def redirect_stdout_stderr( stream ) :
old_stdout = sys.stdout
old_stderr = sys.stderr
sys.stdout = stream
sys.stderr = stream
try :
yield
finally :
sys.stdout = old_stdout
sys.stderr = old_stderr
PK !H^z4 = , contactList-0.1.0.dist-info/entry_points.txtN+I/N.,()
$&dB9>@^j^IQ + PK ljM:~ ~ # contactList-0.1.0.dist-info/LICENSE GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
PK !H>*R Q ! contactList-0.1.0.dist-info/WHEEL HM
K-*ϳR03rOK-J,/RH,rzd&Y)r$[)T&Ur PK !H%ҕ $ contactList-0.1.0.dist-info/METADATAWo6~_q ` 4hvY4 tP3-6Hʩ E)r +!tȼa4:Iz.y)2ȍ<y_G vS%M'p0E{c`a,;oK A5_p]KWQr Ro'.C}~6H*lVW.+>OsSwRcҽ>\
V,^*vRc
65fܔR&~NELm+O]Z2aş ^ Okr++%Qh6g?XTqB
L
YW7pRU֬EAg Lhazdk)(ǔ^# TMWm0
ۥf_VTUɖ5" C3Hb+26㏱JVBI- sB4ⁱ4DĘ/xp;q9Kz .B(-?\Q3wpڵ|;gOw g' 5d]C_j
馋64Zlfus}10clj/W\PThN˲D ^\XtB9F
gJ?nWHYVJ8o0NP ebB$se;s݊Q(M0v& $_ rx|l>:
ic0?Ts+H&qܣ(<ڇO{>>d ILdC?ۮ):80ohd4[ dYGB>u3\\P~%w4u@ۂz 6[7j[Ќ1M>'JݮQ7hȡaa&Eg {
! taM9AHPpؐ~LVOB^]ޞt~<
CL'i5VaE=iLIDas+sKޮ_vk bc
e*mJur8p 49t4ri7iEr;E{]$`#O lF/16?
;.:Kh-R]Dɰala^KU ObEZܚ!W
@lFVOX#DN7RVD[ +ËHrw?Ge6A+!6#ݳa,tt=aR * !/<
=-R,9%FAaX<\ &UDE` :q:I[QpW_3ݷOW"CsqcqK
ܽ ERJ2{D{ DaKP Уa9Q}o<
Q PK !HmD ; " contactList-0.1.0.dist-info/RECORDYɖȒݿoâ16 $y7QUO Eu-rQDnvjAN ִDMw C{w)Ƽ`M 1]ZLf'`'xJY%Y̌]!_ΘMFBd;D^%>]!k+3,mOJҰe.x '"@L#tnzZYVvhC:x'L}@="qT'vw0EQo@o~ }v0.mS)DYq*pƞ\Jh͎Ĉ[?tЋlj`${FhE 48Ёsm A">ZҺzW
j 1 vN iAjp@,aw$.{#a.K C0TX&QH8);F 'lNg_:T!MR2[9x&Tߒ#^{Q"r_&#dڼ}BA%
yW5yDy&<ɠc|ʔGC@dbzCz˒+!rf\1->l d:܈^^IWW1 D]ADL$Oε( a 8Xfzwt3oԎ!|\;=ĥ'w @\c?2 }36-~089W$Y|?i}Tik 9"{ " I~(㜁Ž>UA4 ܳJtm yw%W8vC$D^aU®ӬAA&S 7L/~hǃgKBt*-RN!=]֓e'!͉ t#ep@ 2{lXX C+3걆* S3{y(v$)zr9?ȓkPZ5Kmχ'؎$;h :9Y0;bs DԑDxtuFFJT'6byY
u Gc&
%N^:
/%x=IowLߠ?n2Z
Ҧ|)jF5J;¿ WAr`g-d9%+
>*r
]T~ҿ~~~EH
f&{1ڵQ퐩Vc4qgrwP3F~'O? 揿x͐};,n5&z7ƛȎl
"7d/`zo&-2"pU9w+25TFV9|t)%m&>*<>&wb^Tm]=cpJe$ JoB[7,O"
$
g-O 8 |bUHe<ރ^%{פfѯ@7 LOg
$_sr $aCabfq_eW2W8^5TWi( -ء0!,ca?jȖȾ 0 YSM s
zT+ȢՃ)DJQn> q|_>oW<@i.
T*|WC%/aHKNirHo- o :Pe {l9Dnl= eeۼ%ύxW*]{)'5 ڽH{L-xe+z_m ܊8/Z,Z۴PJVYB4FޭY+X~&Y(DcTm dK` v{ " _4\.I)U, ΉEJ0pTTTڌ. [^_??? i Y/ !YPI\x }` nvdfDt%B! ZCO $4
SE =xJaUFMWW
,+x :g>gČ+PҫC5'jVh:#ߴ|FY9zpi\V0a0 J bw:~nf v PK njM contactList/VERSIONPK ljMK; 7 contactList/__init__.pyPK ljM e z contactList/entry.pyPK ljM ! P contactList/arguments/__init__.pyPK ljMI0 contactList/arguments/top.pyPK ljMi^Y Y & contactList/arguments/base/__init__.pyPK ljMy[ [ & 8 contactList/arguments/base/abstract.pyPK ljM *9c c ' " contactList/arguments/base/exception.pyPK ljM=
=
" & contactList/arguments/base/tree.pyPK ljM K , 3 contactList/arguments/base/tests/__init__.pyPK ljM A' ' 3 7 contactList/arguments/base/tests/testCommandTree.pyPK ljMJ* * ) _ contactList/arguments/cluster/__init__.pyPK ljM(G $ b contactList/arguments/cluster/add.pyPK ljM
9 ( Mg contactList/arguments/cluster/cluster.pyPK ljMްY # nl contactList/arguments/cluster/rm.pyPK ljM K / r contactList/arguments/cluster/tests/__init__.pyPK ljMҍ{M 2 u contactList/arguments/cluster/tests/testCluster.pyPK ljMGT\A 5 } contactList/arguments/cluster/tests/testClusterAdd.pyPK ljM$B0
4 contactList/arguments/cluster/tests/testClusterRm.pyPK ljM $ $ ' contactList/arguments/email/__init__.pyPK ljMߨ " _ contactList/arguments/email/add.pyPK ljM $ contactList/arguments/email/email.pyPK ljM\ ! contactList/arguments/email/rm.pyPK ljM K - contactList/arguments/email/tests/__init__.pyPK ljMΠ4ɓ . contactList/arguments/email/tests/testEmail.pyPK ljM[l 1 ̮ contactList/arguments/email/tests/testEmailAdd.pyPK ljM=A 0 + contactList/arguments/email/tests/testEmailRm.pyPK ljM7o ' contactList/arguments/group/__init__.pyPK ljM>/ɟ " contactList/arguments/group/add.pyPK ljM9 $
contactList/arguments/group/group.pyPK ljM{mr=J J ! contactList/arguments/group/rm.pyPK ljM K - contactList/arguments/group/tests/__init__.pyPK ljMU0
. contactList/arguments/group/tests/testGroup.pyPK ljMCP 1 y contactList/arguments/group/tests/testGroupAdd.pyPK ljMOZG G 0 contactList/arguments/group/tests/testGroupRm.pyPK ljM K ' I contactList/arguments/tests/__init__.pyPK ljMPy y + P
contactList/arguments/tests/testParseTop.pyPK ljMt]H[$ $ contactList/contacts/__init__.pyPK ljMD. t contactList/contacts/contact.pyPK ljMhf % 1 contactList/contacts/base/__init__.pyPK ljMY % n5 contactList/contacts/base/abstract.pyPK ljM?/s s ! : contactList/contacts/base/data.pyPK ljME E & aC contactList/contacts/base/exception.pyPK ljM K + F contactList/contacts/base/tests/__init__.pyPK ljM_>+ 8 I contactList/contacts/base/tests/testContactValidation.pyPK ljM
w. 0 8O contactList/contacts/base/tests/testEmailList.pyPK ljM0G" " ( hW contactList/contacts/cluster/__init__.pyPK ljM,] ) Z contactList/contacts/cluster/operation.pyPK ljM K . m contactList/contacts/cluster/tests/__init__.pyPK ljML < p contactList/contacts/cluster/tests/testContactsAddCluster.pyPK ljM~w w ? $ contactList/contacts/cluster/tests/testContactsRemoveCluster.pyPK ljM` & contactList/contacts/email/__init__.pyPK ljMs
' Z contactList/contacts/email/operation.pyPK ljM K , f contactList/contacts/email/tests/__init__.pyPK ljM 8 r contactList/contacts/email/tests/testContactsAddEmail.pyPK ljM}w
; Y contactList/contacts/email/tests/testContactsRemoveEmail.pyPK ljM%y & contactList/contacts/group/__init__.pyPK ljM-R ' contactList/contacts/group/operation.pyPK ljM K , contactList/contacts/group/tests/__init__.pyPK ljMZ Z 8 contactList/contacts/group/tests/testContactsAddGroup.pyPK ljM5cM ; w contactList/contacts/group/tests/testContactsRemoveGroup.pyPK ljM K & W contactList/contacts/tests/__init__.pyPK ljMlz z * ] contactList/contacts/tests/testContacts.pyPK ljMH 2 contactList/tests/__init__.pyPK ljMw / / ( 4 contactList/tests/testContactsOptions.pyPK ljMȍ # Ld contactList/tests/testEntrypoint.pyPK ljM +j contactList/tests/testMain.pyPK ljM* # y contactList/tests/testYamlExport.pyPK ljM0 # : contactList/tests/testYamlImport.pyPK ljMy", contactList/tests/utility.pyPK !H^z4 = , contactList-0.1.0.dist-info/entry_points.txtPK ljM:~ ~ # contactList-0.1.0.dist-info/LICENSEPK !H>*R Q ! ," contactList-0.1.0.dist-info/WHEELPK !H%ҕ $ " contactList-0.1.0.dist-info/METADATAPK !HmD ; " ( contactList-0.1.0.dist-info/RECORDPK K K S 4