From ea792cbf87248c81fe8b3551f6b362832495815e Mon Sep 17 00:00:00 2001 From: Julien Nicoulaud Date: Mon, 10 Jan 2011 23:46:27 +0100 Subject: [PATCH] Add a mechanism for testing the correctness of the highlighting. Feel free to add more test data ! Signed-off-by: Julien Nicoulaud --- tests/data/multiple-redirections.zsh | 48 ++++++++++++- tests/data/nested-parentheses.zsh | 36 +++++++++- tests/data/simple-command.zsh | 36 +++++++++- tests/data/simple-redirection.zsh | 40 ++++++++++- tests/data/unknown-command.zsh | 36 +++++++++- tests/data/zsh-syntax-highlighting.zsh | 1 - tests/test-highlighting.zsh | 94 ++++++++++++++++++++++++++ tests/test-perfs.zsh | 54 +++++++++++++++ tests/tests.zsh | 16 ----- 9 files changed, 339 insertions(+), 22 deletions(-) delete mode 120000 tests/data/zsh-syntax-highlighting.zsh create mode 100755 tests/test-highlighting.zsh create mode 100755 tests/test-perfs.zsh delete mode 100755 tests/tests.zsh diff --git a/tests/data/multiple-redirections.zsh b/tests/data/multiple-redirections.zsh index bc9f91d..ac0606c 100644 --- a/tests/data/multiple-redirections.zsh +++ b/tests/data/multiple-redirections.zsh @@ -1 +1,47 @@ -ps aux | grep java | sort | uniq | tail | head +#!/usr/bin/env zsh +# ------------------------------------------------------------------------------------------------- +# Copyright (c) 2010-2011 zsh-syntax-highlighting contributors +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are permitted +# provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this list of conditions +# and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, this list of +# conditions and the following disclaimer in the documentation and/or other materials provided +# with the distribution. +# * Neither the name of the zsh-syntax-highlighting contributors nor the names of its contributors +# may be used to endorse or promote products derived from this software without specific prior +# written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +# FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER +# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# ------------------------------------------------------------------------------------------------- +# -*- mode: zsh; sh-indentation: 2; indent-tabs-mode: nil; sh-basic-offset: 2; -*- +# vim: ft=zsh sw=2 ts=2 et +# ------------------------------------------------------------------------------------------------- + +BUFFER='ps aux | grep java | sort | uniq | tail | head' + +expected_region_highlight=( + "1 2 $ZSH_HIGHLIGHT_STYLES[command]" # ps + "4 6 $ZSH_HIGHLIGHT_STYLES[default]" # aux + "8 8 $ZSH_HIGHLIGHT_STYLES[default]" # | + "10 13 $ZSH_HIGHLIGHT_STYLES[command]" # grep + "15 18 $ZSH_HIGHLIGHT_STYLES[default]" # java + "20 20 $ZSH_HIGHLIGHT_STYLES[default]" # | + "22 25 $ZSH_HIGHLIGHT_STYLES[command]" # sort + "27 27 $ZSH_HIGHLIGHT_STYLES[default]" # | + "29 32 $ZSH_HIGHLIGHT_STYLES[command]" # uniq + "34 34 $ZSH_HIGHLIGHT_STYLES[default]" # | + "36 39 $ZSH_HIGHLIGHT_STYLES[command]" # tail + "41 41 $ZSH_HIGHLIGHT_STYLES[default]" # | + "43 46 $ZSH_HIGHLIGHT_STYLES[command]" # head +) diff --git a/tests/data/nested-parentheses.zsh b/tests/data/nested-parentheses.zsh index 4e0016d..8406282 100644 --- a/tests/data/nested-parentheses.zsh +++ b/tests/data/nested-parentheses.zsh @@ -1 +1,35 @@ -echo $(echo ${(z)array}) +#!/usr/bin/env zsh +# ------------------------------------------------------------------------------------------------- +# Copyright (c) 2010-2011 zsh-syntax-highlighting contributors +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are permitted +# provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this list of conditions +# and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, this list of +# conditions and the following disclaimer in the documentation and/or other materials provided +# with the distribution. +# * Neither the name of the zsh-syntax-highlighting contributors nor the names of its contributors +# may be used to endorse or promote products derived from this software without specific prior +# written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +# FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER +# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# ------------------------------------------------------------------------------------------------- +# -*- mode: zsh; sh-indentation: 2; indent-tabs-mode: nil; sh-basic-offset: 2; -*- +# vim: ft=zsh sw=2 ts=2 et +# ------------------------------------------------------------------------------------------------- + +BUFFER='echo $(echo ${(z)array})' + +expected_region_highlight=( + # TODO +) diff --git a/tests/data/simple-command.zsh b/tests/data/simple-command.zsh index 9e2740c..4227c80 100644 --- a/tests/data/simple-command.zsh +++ b/tests/data/simple-command.zsh @@ -1 +1,35 @@ -ls +#!/usr/bin/env zsh +# ------------------------------------------------------------------------------------------------- +# Copyright (c) 2010-2011 zsh-syntax-highlighting contributors +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are permitted +# provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this list of conditions +# and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, this list of +# conditions and the following disclaimer in the documentation and/or other materials provided +# with the distribution. +# * Neither the name of the zsh-syntax-highlighting contributors nor the names of its contributors +# may be used to endorse or promote products derived from this software without specific prior +# written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +# FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER +# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# ------------------------------------------------------------------------------------------------- +# -*- mode: zsh; sh-indentation: 2; indent-tabs-mode: nil; sh-basic-offset: 2; -*- +# vim: ft=zsh sw=2 ts=2 et +# ------------------------------------------------------------------------------------------------- + +BUFFER='ls' + +expected_region_highlight=( + "1 2 $ZSH_HIGHLIGHT_STYLES[command]" # ls +) diff --git a/tests/data/simple-redirection.zsh b/tests/data/simple-redirection.zsh index 39899ac..055b1cb 100644 --- a/tests/data/simple-redirection.zsh +++ b/tests/data/simple-redirection.zsh @@ -1 +1,39 @@ -ps aux | grep java +#!/usr/bin/env zsh +# ------------------------------------------------------------------------------------------------- +# Copyright (c) 2010-2011 zsh-syntax-highlighting contributors +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are permitted +# provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this list of conditions +# and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, this list of +# conditions and the following disclaimer in the documentation and/or other materials provided +# with the distribution. +# * Neither the name of the zsh-syntax-highlighting contributors nor the names of its contributors +# may be used to endorse or promote products derived from this software without specific prior +# written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +# FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER +# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# ------------------------------------------------------------------------------------------------- +# -*- mode: zsh; sh-indentation: 2; indent-tabs-mode: nil; sh-basic-offset: 2; -*- +# vim: ft=zsh sw=2 ts=2 et +# ------------------------------------------------------------------------------------------------- + +BUFFER='ps aux | grep java' + +expected_region_highlight=( + "1 2 $ZSH_HIGHLIGHT_STYLES[command]" # ps + "4 6 $ZSH_HIGHLIGHT_STYLES[default]" # aux + "8 8 $ZSH_HIGHLIGHT_STYLES[default]" # | + "9 12 $ZSH_HIGHLIGHT_STYLES[command]" # grep + "14 17 $ZSH_HIGHLIGHT_STYLES[default]" # java +) diff --git a/tests/data/unknown-command.zsh b/tests/data/unknown-command.zsh index cbd38df..74854d4 100644 --- a/tests/data/unknown-command.zsh +++ b/tests/data/unknown-command.zsh @@ -1 +1,35 @@ -azertyuiop +#!/usr/bin/env zsh +# ------------------------------------------------------------------------------------------------- +# Copyright (c) 2010-2011 zsh-syntax-highlighting contributors +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are permitted +# provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this list of conditions +# and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, this list of +# conditions and the following disclaimer in the documentation and/or other materials provided +# with the distribution. +# * Neither the name of the zsh-syntax-highlighting contributors nor the names of its contributors +# may be used to endorse or promote products derived from this software without specific prior +# written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +# FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER +# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# ------------------------------------------------------------------------------------------------- +# -*- mode: zsh; sh-indentation: 2; indent-tabs-mode: nil; sh-basic-offset: 2; -*- +# vim: ft=zsh sw=2 ts=2 et +# ------------------------------------------------------------------------------------------------- + +BUFFER='azertyuiop' + +expected_region_highlight=( + "1 10 $ZSH_HIGHLIGHT_STYLES[unknown-token]" # azertyuiop +) diff --git a/tests/data/zsh-syntax-highlighting.zsh b/tests/data/zsh-syntax-highlighting.zsh deleted file mode 120000 index e1c0df3..0000000 --- a/tests/data/zsh-syntax-highlighting.zsh +++ /dev/null @@ -1 +0,0 @@ -../../zsh-syntax-highlighting.zsh \ No newline at end of file diff --git a/tests/test-highlighting.zsh b/tests/test-highlighting.zsh new file mode 100755 index 0000000..7166eae --- /dev/null +++ b/tests/test-highlighting.zsh @@ -0,0 +1,94 @@ +#!/usr/bin/env zsh +# ------------------------------------------------------------------------------------------------- +# Copyright (c) 2010-2011 zsh-syntax-highlighting contributors +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are permitted +# provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this list of conditions +# and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, this list of +# conditions and the following disclaimer in the documentation and/or other materials provided +# with the distribution. +# * Neither the name of the zsh-syntax-highlighting contributors nor the names of its contributors +# may be used to endorse or promote products derived from this software without specific prior +# written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +# FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER +# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# ------------------------------------------------------------------------------------------------- +# -*- mode: zsh; sh-indentation: 2; indent-tabs-mode: nil; sh-basic-offset: 2; -*- +# vim: ft=zsh sw=2 ts=2 et +# ------------------------------------------------------------------------------------------------- + + +local -a errors highlight_zone +local -A observed_result + +# Load the main script. +. $(dirname $0)/../zsh-syntax-highlighting.zsh + +# Process each test data file in data/. +for data_file in $(dirname $0)/data/*.zsh; do + + # Load the data and prepare checking it. + BUFFER= ; expected_region_highlight=(); errors=() + echo -n "* ${data_file:t:r}: " + . $data_file + + # Check the data declares $BUFFER. + if [[ ${#BUFFER} -eq 0 ]]; then + errors+=("'BUFFER' is not declared or blank.") + else + + # Check the data declares $expected_region_highlight. + if [[ ${#expected_region_highlight} -eq 0 ]]; then + errors+=("'expected_region_highlight' is not declared or empty.") + else + + # Process the data. + region_highlight=() + _zsh_highlight-zle-buffer + + # Overlapping regions can be declared in region_highlight, so we first build an array of the + # observed highlighting. + observed_result=() + for i in {1..${#region_highlight}}; do + highlight_zone=${(z)region_highlight[$i]} + for j in {$highlight_zone[1]..$highlight_zone[2]}; do + observed_result[$j]=$highlight_zone[3] + done + done + + # Then we compare the observed result with the expected one. + for i in {1..${#expected_region_highlight}}; do + highlight_zone=${(z)expected_region_highlight[$i]} + for j in {$highlight_zone[1]..$highlight_zone[2]}; do + if [[ "$observed_result[$j]" != "$highlight_zone[3]" ]]; then + errors+=("'$BUFFER[$highlight_zone[1],$highlight_zone[2]]' [$highlight_zone[1],$highlight_zone[2]]: expected '$highlight_zone[3]', observed '$observed_result[$j]'.") + break + fi + done + done + + fi + fi + + # Format result/errors. + if [[ ${#errors} -eq 0 ]]; then + echo "OK" + else + echo "KO" + for error in $errors; do + echo " - $error" + done + fi + +done diff --git a/tests/test-perfs.zsh b/tests/test-perfs.zsh new file mode 100755 index 0000000..570bce6 --- /dev/null +++ b/tests/test-perfs.zsh @@ -0,0 +1,54 @@ +#!/usr/bin/env zsh +# ------------------------------------------------------------------------------------------------- +# Copyright (c) 2010-2011 zsh-syntax-highlighting contributors +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are permitted +# provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this list of conditions +# and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, this list of +# conditions and the following disclaimer in the documentation and/or other materials provided +# with the distribution. +# * Neither the name of the zsh-syntax-highlighting contributors nor the names of its contributors +# may be used to endorse or promote products derived from this software without specific prior +# written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +# FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER +# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# ------------------------------------------------------------------------------------------------- +# -*- mode: zsh; sh-indentation: 2; indent-tabs-mode: nil; sh-basic-offset: 2; -*- +# vim: ft=zsh sw=2 ts=2 et +# ------------------------------------------------------------------------------------------------- + + +# Load the main script. +. $(dirname $0)/../zsh-syntax-highlighting.zsh + +# Process each test data file in data/. +for data_file in $(dirname $0)/data/*.zsh; do + + # Load the data and prepare checking it. + BUFFER= + echo -n "* ${data_file:t:r}: " + . $data_file + + # Check the data declares $BUFFER. + if [[ ${#BUFFER} -eq 0 ]]; then + echo "KO\n - 'BUFFER' is not declared or blank." + else + + # Measure the time taken by _zsh_highlight-zle-buffer. + TIMEFMT="%*Es" + time ( BUFFER="$BUFFER" && _zsh_highlight-zle-buffer) + + fi + +done diff --git a/tests/tests.zsh b/tests/tests.zsh deleted file mode 100755 index 79dc77d..0000000 --- a/tests/tests.zsh +++ /dev/null @@ -1,16 +0,0 @@ -#!/usr/bin/env zsh -# -*- mode: zsh; sh-indentation: 2; indent-tabs-mode: nil; sh-basic-offset: 2; -*- -# vim: ft=zsh sw=2 ts=2 et - -# Copyleft 2011 zsh-syntax-highlighting contributors -# http://github.com/nicoulaj/zsh-syntax-highlighting -# All wrongs reserved. - - -source $(dirname $0)/../zsh-syntax-highlighting.zsh - -TIMEFMT="%*Es" -for buffer in $(dirname $0)/data/*.zsh; do - echo -n "${buffer:t:r}: " - time ( BUFFER="`cat $buffer`" && _zsh_highlight-zle-buffer ) -done