Merge branch '0.0.14-dev'

Author: rcaloras

bashhub/bashhub.py

@@ -10,12 +10,14 @@
 from model import UserContext
 import rest_client
 import bashhub_setup
-from bashhub_globals import *
+import bashhub_globals
+from bashhub_globals import BH_USER_ID, BH_SYSTEM_ID, BH_FILTER
 from version import __version__
 import shutil
 import requests
 import subprocess
 import shell_utils
+import re
 from view.status import *
 
 def print_version(ctx, param, value):
@@ -47,14 +49,18 @@ def version():
 @click.argument('exit_status', type=int)
 def save(command, path, pid, process_start_time, exit_status):
     """Save a command to bashhub.com"""
-
     pid_start_time = unix_time_to_epoc_millis(process_start_time)
     command = command.strip()
 
-    # Check if we should ignore this commannd or not.
+    # Check if we should ignore this command.
     if "#ignore" in command:
         return
 
+    # Check if we should filter this command.
+    bh_filter = bashhub_globals.BH_FILTER
+    if bh_filter and re.findall(bh_filter, command):
+        return
+
     context = UserContext(pid, pid_start_time, BH_USER_ID, BH_SYSTEM_ID)
     command = CommandForm(command, path, exit_status, context)
     rest_client.save_command(command)
@@ -72,6 +78,43 @@ def status():
     status_view = rest_client.get_status_view(user_context)
     click.echo(build_status_view(status_view))
 
+
+@bashhub.command()
+@click.pass_context
+def help(ctx):
+    """Show this message and exit"""
+    click.echo(ctx.parent.get_help())
+
+
+
+# Dynamic help text containing the BH_FILTER variable.
+filtered_text = "BH_FILTER={0}".format(BH_FILTER) if BH_FILTER else "BH_FILTER \
+is unset."
+filter_help_text = """Check if a command is filtered from bashhub. Filtering
+is configured via a regex exported as BH_FILTER.
+\n
+{0}""".format(filtered_text)
+
+@bashhub.command(help=filter_help_text)
+@click.argument('command', type=str)
+@click.option('-r', '--regex', default=BH_FILTER, help='Regex to filter against')
+def filter(command, regex):
+
+    # Check if the regex we receive is valid
+    if not bashhub_globals.is_valid_regex(regex):
+        click.secho("Regex {0} is invalid".format(regex), fg='red')
+        return
+
+    v = re.findall(regex, command)
+    click.echo(filtered_text)
+    if v and regex:
+        matched = [str(s) for s in set(v)]
+        output = click.style("{0} \nIs Filtered. Matched ".format(command),
+                fg='yellow') + click.style(str(matched), fg='red')
+        click.echo(output)
+    else:
+        click.echo("{0} \nIs Unfiltered".format(command))
+
 @bashhub.command()
 @click.argument('version', type=str, default="")
 def update(version):
@@ -124,7 +167,6 @@ def main():
         bashhub()
     except Exception as e:
         formatted = traceback.format_exc(e)
-        click.echo("Oops, look like an exception occured: " + str(e))
+        click.echo("Oops, looks like an exception occured: " + str(e))
         sys.exit(1)
 
-main()

bashhub/bashhub_globals.py

@@ -4,21 +4,25 @@
 """
 
 import os
-
-def get_global_from_env(env_var, default):
-    return default if env_var not in os.environ.keys() \
-            else os.environ[env_var]
-
+import re
 
 # Optional environment variable to configure for development
 # export BH_URL='http://localhost:9000'
-BH_URL = get_global_from_env('BH_URL', 'https://bashhub.com')
+BH_URL = os.getenv('BH_URL', 'https://bashhub.com')
 
-BH_USER_ID = get_global_from_env('BH_USER_ID', '')
+BH_USER_ID = os.getenv('BH_USER_ID', '')
 
-BH_SYSTEM_ID = get_global_from_env('BH_SYSTEM_ID', '')
+BH_SYSTEM_ID = os.getenv('BH_SYSTEM_ID', '')
 
-BH_HOME = "~/.bashhub" if "HOME" not in os.environ.keys() \
-        else os.environ["HOME"] + '/.bashhub'
+BH_HOME = '~/.bashhub' if 'HOME' not in os.environ.keys() \
+        else os.environ['HOME'] + '/.bashhub'
 
+def is_valid_regex(regex):
+    try:
+        re.compile(regex)
+        return True
+    except re.error:
+        return False
 
+BH_FILTER = os.getenv('BH_FILTER', '') if is_valid_regex(os.getenv('BH_FILTER', '')) \
+        else '__invalid__'

bashhub/bashhub_setup.py

@@ -17,7 +17,6 @@
 import requests
 from requests import ConnectionError
 from requests import HTTPError
-import hashlib
 
 def query_yes_no(question, default="yes"):
     """Ask a yes/no question via raw_input() and return their answer.
@@ -182,6 +181,12 @@ def main():
             sys.exit(0)
 
         system_id = handle_system_information(user_id)
+
+        if system_id == None:
+            print("Sorry looks like getting your info failed.\
+                    Exiting...")
+            sys.exit(0)
+
         write_config_file(user_id, system_id)
         sys.exit(0)
 

bashhub/shell/deps/bash-preexec.sh

@@ -11,7 +11,7 @@
 # Author: Ryan Caloras ([email protected])
 # Forked from Original Author: Glyph Lefkowitz
 #
-# V0.2.1
+# V0.2.3
 #
 
 # General Usage:
@@ -40,6 +40,20 @@ if [[ "$__bp_imported" == "defined" ]]; then
 fi
 __bp_imported="defined"
 
+
+# Remove ignorespace and or replace ignoreboth from HISTCONTROL
+# so we can accurately invoke preexec with a command from our
+# history even if it starts with a space.
+__bp_adjust_histcontrol() {
+    local histcontrol
+    histcontrol="${HISTCONTROL//ignorespace}"
+    # Replace ignoreboth with ignoredups
+    if [[ "$histcontrol" == *"ignoreboth"* ]]; then
+        histcontrol="ignoredups:${histcontrol//ignoreboth}"
+    fi;
+    export HISTCONTROL="$histcontrol"
+}
+
 # This variable describes whether we are currently in "interactive mode";
 # i.e. whether this shell has just executed a prompt and is waiting for user
 # input.  It documents whether the current command invoked by the trace hook is
@@ -71,10 +85,11 @@ __bp_precmd_invoke_cmd() {
 
     # For every function defined in our function array. Invoke it.
     local precmd_function
-    for precmd_function in ${precmd_functions[@]}; do
+    for precmd_function in "${precmd_functions[@]}"; do
 
         # Only execute this function if it actually exists.
-        if [[ -n $(type -t $precmd_function) ]]; then
+        # Test existence of functions with: declare -[Ff]
+        if type -t "$precmd_function" 1>/dev/null; then
             __bp_set_ret_value $ret_value
             $precmd_function
         fi
@@ -96,7 +111,7 @@ __bp_in_prompt_command() {
     local trimmed_arg
     trimmed_arg=$(__bp_trim_whitespace "$1")
 
-    local prompt_command_function
+    local command
     for command in "${prompt_command_array[@]}"; do
         local trimmed_command
         trimmed_command=$(__bp_trim_whitespace "$command")
@@ -146,10 +161,11 @@ __bp_preexec_invoke_exec() {
         return
     fi
 
-    local this_command="$(history 1 | sed -e "s/^[ ]*[0-9]*[ ]*//g")";
+    local this_command
+    this_command=$(HISTTIMEFORMAT= history 1 | { read -r _ this_command; echo "$this_command"; })
 
     # Sanity check to make sure we have something to invoke our function with.
-    if [ -z "$this_command" ]; then
+    if [[ -z "$this_command" ]]; then
         return
     fi
 
@@ -162,7 +178,8 @@ __bp_preexec_invoke_exec() {
     for preexec_function in "${preexec_functions[@]}"; do
 
         # Only execute each function if it actually exists.
-        if [[ -n $(type -t $preexec_function) ]]; then
+        # Test existence of function with: declare -[fF]
+        if type -t "$preexec_function" 1>/dev/null; then
             $preexec_function "$this_command"
         fi
     done
@@ -172,7 +189,7 @@ __bp_preexec_invoke_exec() {
 __bp_preexec_and_precmd_install() {
 
     # Make sure this is bash that's running this and return otherwise.
-    if [ -z "$BASH_VERSION" ]; then
+    if [[ -z "$BASH_VERSION" ]]; then
         return 1;
     fi
 
@@ -181,12 +198,17 @@ __bp_preexec_and_precmd_install() {
         return 1;
     fi
 
+    # Adjust our HISTCONTROL Variable if needed.
+    __bp_adjust_histcontrol
+
     # Take our existing prompt command and append a semicolon to it
     # if it doesn't already have one.
     local existing_prompt_command
 
-    if [ -n "$PROMPT_COMMAND" ]; then
-        existing_prompt_command=$(echo "$PROMPT_COMMAND" | sed '/; *$/!s/$/;/')
+    if [[ -n "$PROMPT_COMMAND" ]]; then
+        existing_prompt_command=${PROMPT_COMMAND%${PROMPT_COMMAND##*[![:space:]]}}
+        existing_prompt_command=${existing_prompt_command%;}
+        existing_prompt_command=${existing_prompt_command/%/;}
     else
         existing_prompt_command=""
     fi

bashhub/version.py

@@ -1 +1 @@
-__version__ =   '0.0.13'
+__version__ =   '0.0.14'

bashhub/view/status.py

@@ -4,7 +4,7 @@
 
 status_view ="""\
 === Bashhub Status
-http://bashhub.com/u/{0}
+https://bashhub.com/u/{0}
 Total Commands: {1}
 Total Sessions: {2}
 Total Systems:  {3}

install-bashhub.sh

@@ -41,7 +41,7 @@ zshprofile=~/.zshrc
 
 # Optional parameter to specify a github branch
 # to pull from.
-github_branch=${1:-'0.0.13'}
+github_branch=${1:-'0.0.14'}
 
 install_bashhub() {
     check_dependencies

tests/test_bashhub.py

@@ -0,0 +1,47 @@
+import os
+
+import click
+from click.testing import CliRunner
+
+from bashhub.bashhub import bashhub
+from bashhub.version import __version__
+from bashhub.bashhub import rest_client
+from bashhub.bashhub import bashhub_globals
+
+def test_bashhub_save():
+
+    def print_failed(command):
+        print("Failed")
+        pass
+
+    rest_client.save_command = print_failed
+
+    runner = CliRunner()
+    args = ['save',
+            'echo "Running bashhub tests"',
+            '/tmp',
+            '1',
+            '100000',
+            '1']
+
+    ignored_command = ['save',
+            'echo "Running bashhub tests" #ignore',
+            '/tmp',
+            '1',
+            '100000',
+            '1']
+
+    # Should omit saving if #ignore is set
+    result = runner.invoke(bashhub, ignored_command)
+    assert '' == result.output
+
+    # Should omit saving a command if BH_FILTER regex is set
+    #bashhub_globals = Temp()
+    bashhub_globals.BH_FILTER = 'echo'
+    result = runner.invoke(bashhub, args)
+    assert '' == result.output
+
+def test_bashhub_version():
+    runner = CliRunner()
+    result = runner.invoke(bashhub, ['version'])
+    assert __version__ in result.output

tests/test_bashhub_globals.py

@@ -0,0 +1,10 @@
+
+from bashhub.bashhub import bashhub_globals
+
+def test_is_valid_regex():
+    invalid_regex = '[a-2]'
+    valid_regex = '(filter_me|ssh)'
+    assert False == bashhub_globals.is_valid_regex(invalid_regex)
+    assert True == bashhub_globals.is_valid_regex(valid_regex)
+
+