init upload

tests/action_options.sh

@@ -0,0 +1,125 @@
+#!/usr/bin/env sh
+
+# Tests for final action options with various flameshot commands
+# Arguments:
+# 1. path to tested flameshot executable
+
+# Dependencies:
+# - display command (imagemagick)
+
+# HOW TO USE:
+# - Start the script with path to tested flameshot executable as the first
+#   argument
+#
+# - Read messages from stdout and see if flameshot sends the right notifications
+#
+#   Some commands will pin screenshots to the screen. Check if that is happening
+#   correctly. NOTE: the screen command will pin one screenshot over your entire
+#   screen, so don't be confused by that.
+#
+# - When the flameshot gui is tested, follow the instructions from the system
+#   notifications
+#
+# - Some tests may ask you for confirmation in the CLI before continuing.
+# - Whenever the --raw option is tested, the `display` command is used to open
+#   the image from stdout in a window. Just close that window.
+#
+
+FLAMESHOT="$1"
+[ -z "$FLAMESHOT" ] && FLAMESHOT="flameshot"
+
+# --raw >/dev/null is a hack that makes the subcommand wait for the daemon to
+# finish the pending action
+flameshot() {
+    command "$FLAMESHOT" "$@" --raw >/tmp/img.png
+}
+
+# Print the given command and run it
+cmd() {
+    echo "$*" >&2
+    "$@"
+    sleep 1
+}
+
+notify() {
+  if [ "$FLAMESHOT_PLATFORM" = "MAC" ]
+  then
+osascript -  "$1"  <<EOF
+  on run argv
+    display notification (item 1 of argv) with title "Flameshot"
+  end run
+EOF
+
+  else
+    notify-send "GUI Test 1: --path" "Make a selection, then accept"
+  fi
+}
+
+display_img() {
+  if [ "$FLAMESHOT_PLATFORM" = "MAC" ]
+  then
+    open -a Preview.app -f
+  else
+    display
+  fi
+}
+
+
+
+
+wait_for_key() {
+    echo "Press Enter to continue..." >&2 && read ____
+}
+
+# NOTE: Upload option is intentionally not tested
+
+#   flameshot full & screen
+# ┗━━━━━━━━━━━━━━━━━━━━━━━━┛
+
+for subcommand in full screen
+do
+    cmd flameshot "$subcommand" --path /tmp/
+    cmd flameshot "$subcommand" --clipboard
+    cmd command "$FLAMESHOT" "$subcommand" --raw | display_img
+    [ "$subcommand" = "full" ] && sleep 1
+    echo
+done
+
+echo "The next command will pin a screenshot over your entire screen."
+echo "Make sure to close it afterwards"
+echo "Press Enter to continue..."
+read ____
+flameshot screen --pin
+sleep 1
+
+#   flameshot gui
+# ┗━━━━━━━━━━━━━━━┛
+
+wait_for_key
+notify "GUI Test 1: --path" #"Make a selection, then accept"
+cmd flameshot gui --path /tmp/
+wait_for_key
+notify "GUI Test 2: Clipboard" "Make a selection, then accept"
+cmd flameshot gui --clipboard
+wait_for_key
+notify "GUI Test 3: Print geometry" "Make a selection, then accept"
+cmd command "$FLAMESHOT" gui --print-geometry
+wait_for_key
+notify "GUI Test 4: Pin" "Make a selection, then accept"
+cmd flameshot gui --pin
+wait_for_key
+notify "GUI Test 5: Print raw" "Make a selection, then accept"
+cmd command "$FLAMESHOT" gui --raw | display_img
+wait_for_key
+notify "GUI Test 6: Copy on select" "Make a selection, flameshot will close automatically"
+cmd flameshot gui --clipboard --accept-on-select
+wait_for_key
+notify "GUI Test 7: File dialog on select" "After selecting, a file dialog will open"
+cmd flameshot gui --accept-on-select
+
+# All options except for --print-geometry (incompatible with --raw)
+wait_for_key
+notify "GUI Test 8: All actions except print-geometry" "Just make a selection"
+cmd command "$FLAMESHOT" gui -p /tmp/ -c -r --pin | display_img
+
+echo '>> All tests done.'

tests/path_option.sh

@@ -0,0 +1,52 @@
+#!/usr/bin/env sh
+
+# Before running the script make sure a flameshot daemon with a matching version
+# is running
+
+# The first argument to this script is a path to the flameshot executable
+[ -n "$1" ] && flameshot="$1" || flameshot='flameshot'
+
+# TODO Before proper stderr logging is implemented, you will have to look at the
+# system notifications
+
+rm -rf /tmp/flameshot_path_test 2>/dev/null
+mkdir -p /tmp/flameshot_path_test
+cd /tmp/flameshot_path_test
+
+echo ">> Nonexistent directory. This command should give an invalid path error."
+"$flameshot" screen -p blah/blah
+
+sleep 2
+echo ">> The output file is specified relative to PWD"
+"$flameshot" screen -p relative.png
+
+sleep 2
+echo ">> Absolute paths work too"
+"$flameshot" screen -p /tmp/flameshot_path_test/absolute.png
+
+sleep 2
+mkdir subdir
+echo ">> Redundancy in the path will be removed"
+"$flameshot" screen -p /tmp/flameshot_path_test/subdir/..///redundancy_removed.png
+
+sleep 2
+echo ">> If the destination is a directory, the file name is generated from strf from the config"
+"$flameshot" screen -p ./
+
+sleep 2
+echo ">> If the output file has no suffix, it will be added (png)"
+"$flameshot" screen -p /tmp/flameshot_path_test/without_suffix
+
+sleep 2
+echo ">> Other suffixes are supported, and the image format will match it"
+"$flameshot" screen -p /tmp/flameshot_path_test/jpg_suffix.jpg
+
+sleep 2
+echo ">> If the destination path exists, it will have _NUM appended to the base name"
+"$flameshot" screen -p /tmp/flameshot_path_test/absolute.png
+
+sleep 2
+echo ">> Same thing again but without specifying a suffix"
+"$flameshot" screen -p /tmp/flameshot_path_test/absolute
+
+sleep 2