Skip to content

Commit

Permalink
Alias 0.2.0 (#97)
Browse files Browse the repository at this point in the history 
* Alias 0.2.0

* Run tests against temp folder

* Add test_requirements.txt in ext dir

* Address PR comments

* Address PR comments

* Set PYTHONPATH to temp folder when executing tests

* Concatenate existing PYHTONPATH with the temp folder

* Use os.environ.copy()
  • Loading branch information
@derekbekoe
Ernest Wong authored and derekbekoe committed Mar 15, 2018
1 parent 60bcba6 commit 543252e
Show file tree
Hide file tree
Showing 10 changed files with 424 additions and 130 deletions.
7 changes: 5 additions & 2 deletions scripts/ci/test_source.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,14 @@ def __new__(mcs, name, bases, _dict):

def gen_test(ext_path):
def test(self):
ext_install_dir = os.path.join(self.ext_dir, 'ext')
pip_args = [sys.executable, '-m', 'pip', 'install', '--upgrade', '--target',
os.path.join(self.ext_dir, 'ext'), ext_path]
ext_install_dir, ext_path]
check_call(pip_args)
unittest_args = [sys.executable, '-m', 'unittest', 'discover', '-v', ext_path]
check_call(unittest_args)
env = os.environ.copy()
env['PYTHONPATH'] = ext_install_dir
check_call(unittest_args, env=env)
return test

for tname, ext_path in ALL_TESTS:
Expand Down
13 changes: 7 additions & 6 deletions src/alias/azext_alias/_const.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@
COLLIDED_ALIAS_FILE_NAME = 'collided_alias'
COLLISION_CHECK_LEVEL_DEPTH = 4

PLACEHOLDER_REGEX = r'\s+{\d+}'

INCONSISTENT_INDEXING_ERROR = 'alias: Placeholder indexing should be zero-indexed, but {} is missing in "{}"'
INSUFFICIENT_POS_ARG_ERROR = 'alias: "{}" takes exactly {} argument(s) ({} given)'
CONFIG_PARSING_ERROR = 'alias: Error parsing the configuration file - %s. Please fix the problem manually.'
INSUFFICIENT_POS_ARG_ERROR = 'alias: "{}" takes exactly {} positional argument{} ({} given)'
CONFIG_PARSING_ERROR = 'alias: Error parsing the configuration file - {}. Please fix the problem manually.'
DEBUG_MSG = 'Alias Manager: Transforming "%s" to "%s"'
DEBUG_MSG_WITH_TIMING = 'Alias Manager: Transformed args to %s in %.3fms'
POS_ARG_DEBUG_MSG = 'Alias Manager: Transforming "{}" to "{}", with the following positional arguments: '
POS_ARG_DEBUG_MSG = 'Alias Manager: Transforming "%s" to "%s", with the following positional arguments: %s'
DUPLICATED_PLACEHOLDER_ERROR = 'alias: Duplicated placeholders found when transforming "{}"'
RENDER_TEMPLATE_ERROR = 'alias: Encounted the following error when injecting positional arguments to "{}" - {}'
PLACEHOLDER_EVAL_ERROR = 'alias: Encounted the following error when evaluating "{}" - {}'
PLACEHOLDER_BRACKETS_ERROR = 'alias: Brackets in "{}" are not enclosed properly'
113 changes: 41 additions & 72 deletions src/alias/azext_alias/alias.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,31 @@

import os
import re
import hashlib
import sys
import json
import shlex
import hashlib
from collections import defaultdict
from six.moves import configparser

from knack.log import get_logger
from knack.util import CLIError

from azext_alias import telemetry
from azext_alias._const import (
GLOBAL_CONFIG_DIR,
ALIAS_FILE_NAME,
ALIAS_HASH_FILE_NAME,
COLLIDED_ALIAS_FILE_NAME,
PLACEHOLDER_REGEX,
INCONSISTENT_INDEXING_ERROR,
CONFIG_PARSING_ERROR,
INSUFFICIENT_POS_ARG_ERROR,
DEBUG_MSG,
POS_ARG_DEBUG_MSG,
COLLISION_CHECK_LEVEL_DEPTH
COLLISION_CHECK_LEVEL_DEPTH,
POS_ARG_DEBUG_MSG
)
from azext_alias.argument import (
build_pos_args_table,
render_template
)


GLOBAL_ALIAS_PATH = os.path.join(GLOBAL_CONFIG_DIR, ALIAS_FILE_NAME)
GLOBAL_ALIAS_HASH_PATH = os.path.join(GLOBAL_CONFIG_DIR, ALIAS_HASH_FILE_NAME)
Expand All @@ -34,12 +38,24 @@
logger = get_logger(__name__)


def get_config_parser():
"""
Disable configparser's interpolation function and return an instance of config parser.
Returns:
An instance of config parser with interpolation disabled.
"""
if sys.version_info.major == 3:
return configparser.ConfigParser(interpolation=None) # pylint: disable=unexpected-keyword-arg
return configparser.ConfigParser()


class AliasManager(object):

def __init__(self, **kwargs):
self.alias_table = configparser.ConfigParser()
self.alias_table = get_config_parser()
self.kwargs = kwargs
self.collided_alias = dict()
self.collided_alias = defaultdict(list)
self.reserved_commands = []
self.alias_config_str = ''
self.alias_config_hash = ''
Expand Down Expand Up @@ -81,7 +97,7 @@ def load_collided_alias(self):
collided_alias_str = collided_alias_file.read()
try:
self.collided_alias = json.loads(collided_alias_str if collided_alias_str else '{}')
except Exception: # pylint: disable=broad-except
except Exception: # pylint: disable=broad-except
self.collided_alias = {}

def detect_alias_config_change(self):
Expand Down Expand Up @@ -136,42 +152,33 @@ def transform(self, args):
continue

full_alias = self.get_full_alias(alias)
num_pos_args = AliasManager.count_positional_args(full_alias)

if self.alias_table.has_option(full_alias, 'command'):
cmd_derived_from_alias = self.alias_table.get(full_alias, 'command')
if not num_pos_args:
logger.debug(DEBUG_MSG, alias, cmd_derived_from_alias)
telemetry.set_alias_hit(full_alias)
else:
transformed_commands.append(alias)
continue

if num_pos_args:
# Take arguments indexed from alias_index to alias_index + num_pos_args and inject
# them as positional arguments into the command
pos_args_iter = AliasManager.pos_args_iter(alias, args, alias_index, num_pos_args)
pos_arg_debug_msg = POS_ARG_DEBUG_MSG.format(alias, cmd_derived_from_alias)
for placeholder, pos_arg in pos_args_iter:
if placeholder not in full_alias:
raise CLIError(INCONSISTENT_INDEXING_ERROR.format(placeholder, full_alias))

cmd_derived_from_alias = cmd_derived_from_alias.replace(placeholder, pos_arg)
pos_arg_debug_msg += "({}: {}) ".format(placeholder, pos_arg)
# Skip the next arg because it has been already consumed as a positional argument above
next(alias_iter)
logger.debug(pos_arg_debug_msg)
pos_args_table = build_pos_args_table(full_alias, args, alias_index)
if pos_args_table:
logger.debug(POS_ARG_DEBUG_MSG, full_alias, cmd_derived_from_alias, pos_args_table)
transformed_commands += render_template(cmd_derived_from_alias, pos_args_table)

# Invoke split() because the command derived from the alias might contain spaces
transformed_commands += cmd_derived_from_alias.split()
# Skip the next arg(s) because they have been already consumed as a positional argument above
for pos_arg in pos_args_table: # pylint: disable=unused-variable
next(alias_iter)
else:
logger.debug(DEBUG_MSG, full_alias, cmd_derived_from_alias)
transformed_commands += shlex.split(cmd_derived_from_alias)

return self.post_transform(transformed_commands)

def build_collision_table(self, levels=COLLISION_CHECK_LEVEL_DEPTH):
"""
Build the collision table according to the alias configuration file against the entire command table.
if the word collided with a reserved command. self.collided_alias is structured as:
self.collided_alias is structured as:
{
'collided_alias': [the command level at which collision happens]
}
Expand All @@ -193,8 +200,6 @@ def build_collision_table(self, levels=COLLISION_CHECK_LEVEL_DEPTH):
for level in range(1, levels + 1):
collision_regex = r'^{}{}($|\s)'.format(r'([a-z\-]*\s)' * (level - 1), word.lower())
if list(filter(re.compile(collision_regex).match, self.reserved_commands)):
if word not in self.collided_alias:
self.collided_alias[word] = []
self.collided_alias[word].append(level)
telemetry.set_collided_aliases(list(self.collided_alias.keys()))

Expand All @@ -210,16 +215,16 @@ def get_full_alias(self, query):
"""
if query in self.alias_table.sections():
return query

return next((section for section in self.alias_table.sections() if section.split()[0] == query), '')

def load_full_command_table(self):
"""
Perform a full load of the command table to get all the reserved command words.
"""
load_cmd_tbl_func = self.kwargs.get('load_cmd_tbl_func', None)
if load_cmd_tbl_func:
self.reserved_commands = list(load_cmd_tbl_func([]).keys())
telemetry.set_full_command_table_loaded()
load_cmd_tbl_func = self.kwargs.get('load_cmd_tbl_func', lambda _: {})
self.reserved_commands = list(load_cmd_tbl_func([]).keys())
telemetry.set_full_command_table_loaded()

def post_transform(self, args):
"""
Expand All @@ -233,9 +238,6 @@ def post_transform(self, args):

post_transform_commands = []
for arg in args:
# Trim leading and trailing quotes
if arg and arg[0] == arg[-1] and arg[0] in '\'"':
arg = arg[1:-1]
post_transform_commands.append(os.path.expandvars(arg))

self.write_alias_config_hash()
Expand Down Expand Up @@ -291,36 +293,3 @@ def process_exception_message(exception):
for replace_char in ['\t', '\n', '\\n']:
exception_message = exception_message.replace(replace_char, '' if replace_char != '\t' else ' ')
return exception_message.replace('section', 'alias')

@staticmethod
def pos_args_iter(alias, args, start_index, num_pos_args):
"""
Generate an tuple iterator ([0], [1]) where the [0] is the positional argument
placeholder and [1] is the argument value. e.g. ('{0}', pos_arg_1) -> ('{1}', pos_arg_2) -> ...
Args:
alias: The current alias we are processing.
args: The list of input commands.
start_index: The index where we start selecting the positional arguments
(one-index instead of zero-index).
num_pos_args: The number of positional arguments that this alias has.
"""
pos_args = args[start_index: start_index + num_pos_args]
if len(pos_args) != num_pos_args:
raise CLIError(INSUFFICIENT_POS_ARG_ERROR.format(alias, num_pos_args, len(pos_args)))

for i, pos_arg in enumerate(pos_args):
yield ('{{{}}}'.format(i), pos_arg)

@staticmethod
def count_positional_args(arg):
"""
Count how many positional arguments ({0}, {1} ...) there are.
Args:
arg: The word which this function performs counting on.
Returns:
The number of placeholders in arg.
"""
return len(re.findall(PLACEHOLDER_REGEX, arg))
Loading

0 comments on commit 543252e

Please sign in to comment.