Configure raises an error if CTest scripts print to stdout

[benschreiber]

Brief Issue Summary

My project uses TEST_INCLUDE_FILES to generate labels for CTest tests at runtime.

Our script prints a line Generating test labels... to stdout. This causes CMake Tools to report an error when configuring.

[rollbar] Unhandled exception: Unhandled Promise rejection: cleanConfigure SyntaxError: Unexpected token G in JSON at position 0 {}

[error] SyntaxError: Unexpected token G in JSON at position 0
	at JSON.parse (<anonymous>)
	at CTestDriver.refreshTests (/root/.vscode-server/extensions/ms-vscode.cmake-tools-1.17.17/dist/main.js:50861:37)
	at async /root/.vscode-server/extensions/ms-vscode.cmake-tools-1.17.17/dist/main.js:44894:29
	at async CMakeProject.doConfigure (/root/.vscode-server/extensions/ms-vscode.cmake-tools-1.17.17/dist/main.js:45001:24) cmake.cleanConfigure {"value":"ms-vscode.cmake-tools","_lower":"ms-vscode.cmake-tools"}

This can easily be reproduced.

cmake_minimum_required(VERSION 3.27)
project(foo)

enable_testing()

file(CONFIGURE
    OUTPUT ${PROJECT_BINARY_DIR}/createTestLabels.cmake
    CONTENT "execute_process(COMMAND @CMAKE_COMMAND@ -E echo \"Generating test labels...\")\n"
    @ONLY
)

set_property(DIRECTORY APPEND PROPERTY
    TEST_INCLUDE_FILES ${PROJECT_BINARY_DIR}/createTestLabels.cmake
)

{
    "version": 6,
    "configurePresets": [
        {
            "name": "gcc-debug",
            "binaryDir": "${sourceDir}/out/build/${presetName}",
            "cacheVariables": {
                "CMAKE_CXX_COMPILER": "g++",
                "CMAKE_BUILD_TYPE": "Debug"
            },
            "generator": "Unix Makefiles"
        }
    ],
    "buildPresets": [
        {
            "name": "gcc-debug",
            "configurePreset": "gcc-debug"
        }
    ],
    "testPresets": [
        {
            "name": "gcc-debug",
            "configurePreset": "gcc-debug"
        }
    ]
}

CMake Tools Diagnostics

No response

Debug Log

No response

Additional Information

No response

[Yingzi1234]

@benschreiber Thank you for your github issue! We followed the command you provided to reproduce the issue, but we encountered error below, in order to better reproduce and solve your issue, could you provide us with your reproduction steps video and reproduction file?

[benschreiber]

It looks like you are on windows? Then you can modify the preset to use MSVC and the VS Generator. But it would be easier to just try to reproduce on Linux or in WSL.

[benschreiber]

@Yingzi1234 If you're still stuck, try using this devcontainer.json

{
    "image": "mcr.microsoft.com/devcontainers/cpp:debian-12",
    "customizations": {
        "vscode": {
            "extensions": [
                "ms-vscode.cpptools",
                "ms-vscode.cmake-tools"
            ]
        }
    }
}

[Yingzi1234]

@benschreiber Thanks for your reply, based on the latest information you provided, we tried to reproduce your issue on a Linux machine, but are not sure if we got the same results as your issue. When I run the "CMake: configure" command, an error box pops up, but when I go to the output window, the contents show that my configuration was successful. Here's a recording of my reproduction for you to check out. GitHub issue.webm

[benschreiber]

@Yingzi1234 Yes, that is the same behavior I see. I know that the configure step was successful, but the error box should not pop up.

[Yingzi1234]

Hi @gcampbell-msft, based on customer repro steps we can reproduced this issue on Linux platform(Configuration was successful but an error box appears), you can get the details below and we have been changed the issue's status to "Bug" if it is incorrect, could you help change it to the correct label? Thank you in advance!

ENV:

1. Platform: Linux
2. CMake tools: v1.17.17
3. VScode: 1.89.1

Repro steps:

1. Create a folder on desktop and open it by VScode
2. Create a CMakeLists.txt file and paste the following into it

cmake_minimum_required(VERSION 3.27)
project(foo)

enable_testing()

file(CONFIGURE
    OUTPUT ${PROJECT_BINARY_DIR}/createTestLabels.cmake
    CONTENT "execute_process(COMMAND @CMAKE_COMMAND@ -E echo \"Generating test labels...\")\n"
    @ONLY
)

set_property(DIRECTORY APPEND PROPERTY
    TEST_INCLUDE_FILES ${PROJECT_BINARY_DIR}/createTestLabels.cmake
)

3. Create a CMakePresets.json file and paste the following into it

{
    "version": 6,
    "configurePresets": [
        {
            "name": "gcc-debug",
            "binaryDir": "${sourceDir}/out/build/${presetName}",
            "cacheVariables": {
                "CMAKE_CXX_COMPILER": "g++",
                "CMAKE_BUILD_TYPE": "Debug"
            },
            "generator": "Unix Makefiles"
        }
    ],
    "buildPresets": [
        {
            "name": "gcc-debug",
            "configurePreset": "gcc-debug"
        }
    ],
    "testPresets": [
        {
            "name": "gcc-debug",
            "configurePreset": "gcc-debug"
        }
    ]
}

4. Create a devcontainer.json file and paste the following into it

{
    "image": "mcr.microsoft.com/devcontainers/cpp:debian-12",
    "customizations": {
        "vscode": {
            "extensions": [
                "ms-vscode.cpptools",
                "ms-vscode.cmake-tools"
            ]
        }
    }
}

5. After saving all, click F1 to run "CMake: configure" command

Actual result: It shows that "Configuring done" and "Generating done" but pops up with an error message: "Unexpected token 'G', "Generating"... is not valid JSON" GitHub issue.webm

[v-frankwang]

We verified the issue on CMake tools: v1.19.45 and it has been fixed.

ENV： CMake Tools:v1.19.45 vscode: 1.92.2

Actual result: