Runnable queries do not work on Windows

[Komposten]

What happened?

I clicked on one of the inline runnable buttons (introduced by #79) for a test or main class and got this error:

At line:1 char:113
+ ... st"; m="merge_differentTypesAddedToKey_onlyLatestIsAdded"; if [ -f po ...
+                                                                  ~
Missing '(' after 'if' in if statement.
At line:1 char:115
+ ... "; m="merge_differentTypesAddedToKey_onlyLatestIsAdded"; if [ -f pom. ...
+                                                                  ~
Missing type name after '['.
At line:1 char:228
+ ... if [ -f gradlew ]; then ./gradlew test --tests $c.$m; else >&2 echo ' ...
+                                                                 ~
The ampersand (&) character is not allowed. The & operator is reserved for future use; wrap an ampersand in double quotation marks ("&") to pass it as part of a string.
    + CategoryInfo          : ParserError: (:) [], ParentContainsErrorRecordException
    + FullyQualifiedErrorId : MissingOpenParenthesisInIfStatement

Cause: The tasks definitions use shell scripts which don't run on Windows.

What did you expect to happen?

I expected the test/main class to run.

Environment

Zed: v0.208.0 (Zed Nightly 21e75b82216d91d46f03040d040ab9ef00fa763b)
OS: Windows 10.0.19045
Architecture: x86_64

[playdohface]

I had a similar issue because I am using fish as my default shell and fixed it with #93 but I am not sure this is going to translate for Windows (it still expects to find a POSIX-shell at /bin/sh).

I'd generally like to make these runnable scripts a bit more robust than what they are, and the user should probably also get an opportunity to configure them, but I'm not quite sure what the best approach would be to doing so - my first instinct was to have proper scripts in the extension folder and publish them via ENV-vars. Maybe someone has a better idea?

[Komposten]

I saw your PR but didn't comment on it because I didn't want to risk it being delayed (merging it as-is as opposed to waiting until a platform-agnostic solution is in place).

Setting up platform-specific scripts and then using them depending on platform could be a way, but I don't know if that is possible to configure at the moment?

[playdohface]

There is actually a workaround that I found:
if you create a tasks.json in your project_root/.zed/ directory you can (re-)define the tasks on a per-project basis using any command you like, and zed will prioritize them over the ones provided by the extension.

So specifically:
create a file tasks.json in the .zed-directory with a list of TaskTemplates (the best documentation I found for how they work is in the Zed source code in the docs), here's an example:

[
  {
    "label": "Custom Run Test $ZED_CUSTOM_java_class_name.$ZED_CUSTOM_java_method_name",
    "command": "mvn test -Dtest=$ZED_CUSTOM_java_class_name#$ZED_CUSTOM_java_method_name",
    "use_new_terminal": false,
    "reveal": "always",
    "tags": ["java-test-method"]
  }
]

I don't quite understand when zed will refresh these, I had to sometimes run them manually from the Run>Spawn Task-modal (they will show up if your cursor is at a relevant spot, e.g. a test method)

The label property and the command can be whatever you want and the command will default to your default shell running from your project root directory.
The tags is the magic ingredient and they will have to match the tags we set in our runnables.scm.
Currently they are few and self-explanatory:

• java-main
• java-test-method
• java-test-class

and you can use these captures as environment-vars:

• ZED_CUSTOM_java_package_name
• ZED_CUSTOM_java_class_name
• ZED_CUSTOM_java_method_name
  (plus a bunch more that Zed provides by default but tend to not be relevant for running scripts).

I think other than that, besides providing best-effort defaults we should just document how to do this and encourage people to bring their own tasks until zed-industries/zed#17462 gets some attention.

[Komposten]

There is actually a workaround that I found:
if you create a tasks.json in your project_root/.zed/ directory you can (re-)define the tasks on a per-project basis using any command you like, and zed will prioritize them over the ones provided by the extension.

Weird, that was one of the first things I tested after I first tried to use the runnable, and that time it refused to work. As soon as I added anything with a $ to the task command it wouldn't show up anywhere.

But I just tried overriding with a custom task again and now it seems to work perfectly. 🤔

[playdohface]

That's likely to do with zed-industries/zed#23275 . If you don't get all your vars right, zed will just pretend your script doesn't exist 🙈

[imblowsnow]

same problem @playdohface

所在位置 行:1 字符: 44
+ c="com.xxxx.server.XXXServerApplication"; if [ -f pom.xml ]; then mvn  ...
+                                            ~
if 语句中的“if”后面缺少“(”。
所在位置 行:1 字符: 46
+ c="com.xxxx.server.XXXServerApplication"; if [ -f pom.xml ]; then mvn  ...
+                                              ~
"[" 后面缺少类型名称。
所在位置 行:1 字符: 177
+ ... if [ -f gradlew ]; then ./gradlew run -PmainClass=$c; else >&2 echo ' ...
+                                                                 ~
不允许使用与号(&)。& 运算符是为将来使用而保留的；请用双引号将与号引起来("&")，以将其作为字符串的一部分传递。
    + CategoryInfo          : ParserError: (:) [], ParentContainsErrorRecordException
    + FullyQualifiedErrorId : MissingOpenParenthesisInIfStatement


⏵ Task `Run EmrServerApplication` finished with non-zero error code: 1
⏵ Command: powershell.exe -C 'c="com.xxxx.server.XXXServerApplication"; if [ -f pom.xml ]; then mvn clean compile exec:java -Dexec.mainClass=$c; elif [ -f gradlew ]; then ./gradlew run -PmainClass=$c; else >&2 echo 'No build system found'; exit 1; fi;'

[CharlesIsMeee]

same problem @playdohface

所在位置 行:1 字符: 44
+ c="com.xxxx.server.XXXServerApplication"; if [ -f pom.xml ]; then mvn  ...
+                                            ~
if 语句中的“if”后面缺少“(”。
所在位置 行:1 字符: 46
+ c="com.xxxx.server.XXXServerApplication"; if [ -f pom.xml ]; then mvn  ...
+                                              ~
"[" 后面缺少类型名称。
所在位置 行:1 字符: 177
+ ... if [ -f gradlew ]; then ./gradlew run -PmainClass=$c; else >&2 echo ' ...
+                                                                 ~
不允许使用与号(&)。& 运算符是为将来使用而保留的；请用双引号将与号引起来("&")，以将其作为字符串的一部分传递。
    + CategoryInfo          : ParserError: (:) [], ParentContainsErrorRecordException
    + FullyQualifiedErrorId : MissingOpenParenthesisInIfStatement


⏵ Task `Run EmrServerApplication` finished with non-zero error code: 1
⏵ Command: powershell.exe -C 'c="com.xxxx.server.XXXServerApplication"; if [ -f pom.xml ]; then mvn clean compile exec:java -Dexec.mainClass=$c; elif [ -f gradlew ]; then ./gradlew run -PmainClass=$c; else >&2 echo 'No build system found'; exit 1; fi;'

一个临时凑合的办法，首先把你的默认终端设置为powershell

然后打开 C:\Users\你的用户名\AppData\Local\Zed\extensions\installed\java\languages\java 下的 tasks.json文件

将task文件内容改为

[ { "label": "Run $ZED_CUSTOM_java_class_name", "command": "if (Test-Path 'pom.xml') { mvn clean compile exec:java '-Dexec.mainClass=$ZED_CUSTOM_java_package_name.$ZED_CUSTOM_java_class_name' } elseif ( Test-Path 'gradlew' ) { ./gradlew run '-PmainClass=$ZED_CUSTOM_java_package_name.$ZED_CUSTOM_java_class_name' } else { echo 'No build system found'}", "use_new_terminal": false, "reveal": "always", "tags": ["java-main"] }, { "label": "Test $ZED_CUSTOM_java_class_name.$ZED_CUSTOM_java_method_name", "command": "if (Test-Path 'pom.xml') { mvn clean test '-Dtest=$ZED_CUSTOM_java_package_name.$ZED_CUSTOM_java_class_name#ZED_CUSTOM_java_method_name' } elseif ( Test-Path 'gradlew' ) { ./gradlew test --tests '$ZED_CUSTOM_java_package_name.$ZED_CUSTOM_java_class_name.ZED_CUSTOM_java_method_name' } else { echo 'No build system found'}", "use_new_terminal": false, "reveal": "always", "tags": ["java-test-method"] }, { "label": "Test class $ZED_CUSTOM_java_class_name", "command": "if (Test-Path 'pom.xml') { mvn clean compile test '-Dtest=$ZED_CUSTOM_java_package_name.$ZED_CUSTOM_java_class_name' } elseif ( Test-Path 'gradlew' ) { ./gradlew test --test '$ZED_CUSTOM_java_package_name.$ZED_CUSTOM_java_class_name' } else { echo 'No build system found'}", "use_new_terminal": false, "reveal": "always", "tags": ["java-test-class"] }, { "label": "Run tests", "command": "if (Test-Path 'pom.xml') { mvn clean test } elseif ( Test-Path 'gradlew' ) { ./gradlew test } else { echo 'No build system found'}", "use_new_terminal": false, "reveal": "always" } ]
由于我本人只测试了maven，且我环境变量PATH里配置了mvn，所以如果不行的话需要根据自己的实际情况稍作修改

[tianxing-ovo]

需要修改tasks.json

[prashanth057]

Your suggested work around doesnt work for multi maven module project. Are there other zed custome variables to detect the root of the sub modules when trying to execute specific test class of a sub modules?

[Radiant303]

I am using Zed to run JUnit tests in a Maven Java project.

Running the whole test class works correctly. For example, when I run UserServiceTest, Maven successfully finds and runs the test method, and the output shows:

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

However, when I try to run a single test method from Zed, Maven does not execute any test. The output shows:

Tests run: 0, Failures: 0, Errors: 0, Skipped: 0

The problem appears to be in Zed’s tasks.json configuration for running a single test method.

The generated Maven command is:

mvn clean test '-Dtest=com.javaweb.UserServiceTest#ZED_CUSTOM_java_method_name'

But it should be:

mvn clean test '-Dtest=com.javaweb.UserServiceTest#testIsValidUsername'

In tasks.json, the method name variable is missing the $ symbol.

The incorrect configuration is:

#ZED_CUSTOM_java_method_name

The correct configuration should be:

#$ZED_CUSTOM_java_method_name

Because of this typo, Maven tries to run a method literally named ZED_CUSTOM_java_method_name, which does not exist. As a result, no test method is executed.

The complete tasks.json is as follows

 [
  {
    "label": "Run $ZED_CUSTOM_java_class_name",
    "command": "if (Test-Path 'pom.xml') { mvn clean compile exec:java '-Dexec.mainClass=$ZED_CUSTOM_java_package_name.$ZED_CUSTOM_java_class_name' } elseif ( Test-Path 'gradlew' ) { ./gradlew run '-PmainClass=$ZED_CUSTOM_java_package_name.$ZED_CUSTOM_java_class_name' } else { echo 'No build system found'}",
    "use_new_terminal": false,
    "reveal": "always",
    "tags": ["java-main"]
  },
  {
    "label": "Test $ZED_CUSTOM_java_class_name.$ZED_CUSTOM_java_method_name",
    "command": "if (Test-Path 'pom.xml') { mvn clean test '-Dtest=$ZED_CUSTOM_java_package_name.$ZED_CUSTOM_java_class_name#$ZED_CUSTOM_java_method_name' } elseif ( Test-Path 'gradlew' ) { ./gradlew test --tests '$ZED_CUSTOM_java_package_name.$ZED_CUSTOM_java_class_name.ZED_CUSTOM_java_method_name' } else { echo 'No build system found'}",
    "use_new_terminal": false,
    "reveal": "always",
    "tags": ["java-test-method"]
  },
  {
    "label": "Test class $ZED_CUSTOM_java_class_name",
    "command": "if (Test-Path 'pom.xml') { mvn clean compile test '-Dtest=$ZED_CUSTOM_java_package_name.$ZED_CUSTOM_java_class_name' } elseif ( Test-Path 'gradlew' ) { ./gradlew test --test '$ZED_CUSTOM_java_package_name.$ZED_CUSTOM_java_class_name' } else { echo 'No build system found'}",
    "use_new_terminal": false,
    "reveal": "always",
    "tags": ["java-test-class"]
  },
  {
    "label": "Run tests",
    "command": "if (Test-Path 'pom.xml') { mvn clean test } elseif ( Test-Path 'gradlew' ) { ./gradlew test } else { echo 'No build system found'}",
    "use_new_terminal": false,
    "reveal": "always"
  }
]