From 2a4674eb3ba15f2cfc0ca83eea821dd7d035a09c Mon Sep 17 00:00:00 2001 From: Renato Alves Date: Mon, 27 Jul 2015 23:46:20 +0100 Subject: [PATCH] Test: Convert bash_completion.t to Python Last Perl test converted. Celebration dance: ~o~ \o\ \o| |o| |o/ /o/ ~o~ --- test/bash_completion.t | 271 ++++++++++++++++++++++++----------------- 1 file changed, 159 insertions(+), 112 deletions(-) diff --git a/test/bash_completion.t b/test/bash_completion.t index 0ec40dc1d..e5b81b902 100755 --- a/test/bash_completion.t +++ b/test/bash_completion.t @@ -1,127 +1,174 @@ -#! /usr/bin/env perl -################################################################################ -## -## Copyright 2006 - 2015, Paul Beckingham, Federico Hernandez. -## -## Permission is hereby granted, free of charge, to any person obtaining a copy -## of this software and associated documentation files (the "Software"), to deal -## in the Software without restriction, including without limitation the rights -## to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -## copies of the Software, and to permit persons to whom the Software is -## furnished to do so, subject to the following conditions: -## -## The above copyright notice and this permission notice shall be included -## in all copies or substantial portions of the Software. -## -## THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS -## OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -## FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -## THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -## LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -## OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -## SOFTWARE. -## -## http://www.opensource.org/licenses/mit-license.php -## -################################################################################ +#!/usr/bin/env python2.7 +# -*- coding: utf-8 -*- +############################################################################### +# +# Copyright 2006 - 2015, Paul Beckingham, Federico Hernandez. +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. +# +# http://www.opensource.org/licenses/mit-license.php +# +############################################################################### -use strict; -use warnings; -use Test::More tests => 18; +import sys +import os +import unittest +from contextlib import contextmanager +# Ensure python finds the local simpletap module +sys.path.append(os.path.dirname(os.path.abspath(__file__))) -# Ensure environment has no influence. -delete $ENV{'TASKDATA'}; -delete $ENV{'TASKRC'}; +from basetest import Task, TestCase +from basetest.utils import BIN_PREFIX -# Create the rc file. -if (open my $fh, '>', 'bug.rc') -{ - print $fh "data.location=.\n"; - print $fh "alias.samplealias=long\n"; - print $fh "abbreviation.minimum=5\n"; +TASKSH = os.path.abspath(os.path.join(BIN_PREFIX, "..", "scripts/bash/task.sh")) - close $fh; -} -my $source_dir = $0; -$source_dir =~ s{[^/]+$}{..}; +@contextmanager +def tasksh(t): + cmd_backup = t._command -# Copy task.sh and make substitutions & additions needed for testing. -if (open my $target, '>', 'task.sh') -{ - if (open my $source, '<', "$source_dir/scripts/bash/task.sh") - { - while (<$source>) - { - my $temp=$_; - chomp($_); - if ($_ eq "taskcommand='task rc.verbose:nothing rc.confirmation:no rc.hooks:off'") - { - print $target "taskcommand='../src/task rc.verbose:nothing rc.confirmation:no rc.hooks:off rc:bug.rc'"; - } - else - { - print $target $temp; - } - } - close ($source); - print $target 'COMP_WORDS=("$@")', - "\n", - 'COMP_CWORD=$(($#-1))', - "\n", - '_task', - "\n", - 'for reply_iter in "${COMPREPLY[@]}"; do', - "\n", - ' echo $reply_iter', - "\n", - 'done'; - close $target; - ok (-r 'task.sh', 'Created task.sh'); - } -} + # Use "bash task.sh task" as command + t._command = ["bash", t.tasksh_script, t._command[0]] + yield -# aliases should be expanded -my $output = qx{bash ./task.sh task sampleali 2>&1}; -ok ($? == 0, 'Exit status check'); -like ($output, qr/samplealias/, 'Aliases are expanded'); + # Restore the default "task" command + t._command = cmd_backup -# commands should be expanded -$output = qx{bash ./task.sh task m 2>&1}; -ok ($? == 0, 'Exit status check'); -like ($output, qr/modify/, 'expansion of \'m\' includes \'modify\''); -# "project:" should be expanded correctly and dependent on abbreviation.minimum -qx{../src/task rc:bug.rc add testing project expansion project:todd 2>&1}; +def prepare_tasksh(t): + """Prepare task.sh to be used in tests""" + tasksh = [] -# note the spaces between "projABC", ":", and "to" for correct bash parsing -$output = qx{bash ./task.sh task projeABC : to 2>&1}; -ok ($? == 0, 'Exit status check'); -unlike ($output, qr/todd/, '\'projeABC:\' does not expand'); + # Ensure the task binary used is the same configured for the test + with open(TASKSH) as fh: + for line in fh: + line = line.rstrip() -$output = qx{bash ./task.sh task proje : to 2>&1}; -ok ($? == 0, 'Exit status check'); -like ($output, qr/todd/, '\'proje:\' does expand'); + if line == "taskcommand='task rc.verbose:nothing rc.confirmation:no rc.hooks:off'": + line = "taskcommand='{0} rc.verbose:nothing rc.confirmation:no rc.hooks:off rc:{1}'".format(t.taskw, t.taskrc) -$output = qx{bash ./task.sh task proj : to 2>&1}; -ok ($? == 0, 'Exit status check'); -unlike ($output, qr/todd/, '\'proj:\' does not expand if abbreviation.minimum is 5'); + tasksh.append(line) -$output = qx{TASKRC=bug.rc bash ./task.sh task ad to 2>&1}; -ok ($? == 0, 'Exit status check'); -unlike ($output, qr/override/, 'taskrc override does not display'); + tasksh.extend([ + 'COMP_WORDS=("$@")', + 'COMP_CWORD=$(($#-1))', + '_task', + 'for reply_iter in "${COMPREPLY[@]}"; do', + ' echo $reply_iter', + 'done', + ]) -# there should be no gc coming from bash completion -qx{../src/task rc:bug.rc add this task should be number 2 and stay number 2 2>&1}; -ok ($? == 0, 'Exit status check'); -qx{../src/task rc:bug.rc rc.confirmation:off 1 delete 2>&1}; -ok ($? == 0, 'Exit status check'); -qx{bash ./task.sh task depends : 2>&1}; -ok ($? == 0, 'Exit status check'); -$output = qx{../src/task rc:bug.rc rc.confirmation:off 2 modify shouldreplacetext 2>&1}; -ok ($? == 0, 'Should exit with 0 because task should exist'); -like ($output, qr/shouldreplacetext/, 'no gc was run'); + return '\n'.join(tasksh) -# Cleanup. -unlink qw(pending.data completed.data undo.data backlog.data bug.rc task.sh); -exit 0; + +class TestBashCompletionBase(TestCase): + def setUp(self): + self.t = Task() + + # Used also in tasksh script + self.t.config("alias.samplealias", "long") + self.t.config("abbreviation.minimum", "5") + + self.t.tasksh_script = os.path.join(self.t.datadir, "task.sh") + + with open(self.t.tasksh_script, 'w') as tasksh: + tasksh.write(prepare_tasksh(self.t)) + + +class TestBashCompletion(TestBashCompletionBase): + def test_aliases(self): + """aliases should be expanded""" + with tasksh(self.t): + code, out, err = self.t("sampleali") + + self.assertIn("samplealias", out) + + def test_commands(self): + """commands should be expanded""" + with tasksh(self.t): + code, out, err = self.t("m") + + # Expansion of 'm' should contain modify + self.assertIn("modify", out) + + +class TestProject(TestBashCompletionBase): + def setUp(self): + super(TestProject, self).setUp() + + code, out, err = self.t("add testing project expansion project:todd") + self.assertIn("Created task 1", out) + + # Ensure project was created + code, out, err = self.t("projects") + self.assertIn("todd", out) + + def test_project_non_matching(self): + """project: expansion fails on non matching attribute""" + with tasksh(self.t): + code, out, err = self.t("projeABC : to") + self.assertNotIn("todd", out) + self.assertNotIn("todd", err) + + def test_project_abbreviation_minimum_match(self): + """project: expansion expanded after rc.abbreviation.minimum""" + with tasksh(self.t): + code, out, err = self.t("proje : to") + self.assertIn("todd", out) + + def test_project_abbreviation_minimum_shorter(self): + """project: fails if shorter than rc.abbreviation.minimum""" + with tasksh(self.t): + code, out, err = self.t("proj : to") + self.assertNotIn("todd", out) + self.assertNotIn("todd", err) + + def test_project(self): + """project: should be expanded and dependent on abbreviation minimum""" + with tasksh(self.t): + # TASKRC=test.rc is passed by the test suite by default + code, out, err = self.t("ad to") + # no taskrc override message should be shown + self.assertNotIn("override", out) + self.assertNotIn("override", err) + + def test_gc_bash_completion(self): + """no gc coming from bash completion""" + + code, out, err = self.t("add this task should be number 2 and stay number 2") + self.assertIn("Created task 2", out) + + code, out, err = self.t("1 delete") + self.assertIn("Deleted 1 task", out) + + with tasksh(self.t): + code, out, err = self.t("depends :") + self.assertNotIn("todd", out) + self.assertNotIn("todd", err) + + code, out, err = self.t("2 modify shouldreplacetext") + # Success = no gc was run + self.assertIn("shouldreplacetext", out) + + +if __name__ == "__main__": + from simpletap import TAPTestRunner + unittest.main(testRunner=TAPTestRunner()) + +# vim: ai sts=4 et sw=4