cdk init app: space causes failure #18803

scottiemc7 · 2022-02-02T21:33:17Z

What is the problem?

When running the cdk init app --language csharp command from a directory that has a space in its path, I get the following error:

~\Documents\My Projects\CdkTesting> cdk init app --language csharp

Applying project template app for csharp
Unrecognized command or argument 'Projects\CdkTesting\src\CdkTesting.sln'
Description:
  Add one or more projects to a solution file.

Usage:
  dotnet [options] sln <SLN_FILE> add [<PROJECT_PATH>...]

Arguments:
  <SLN_FILE>      The solution file to operate on. If not specified, the command will search the current directory for
                  one. [default: C:\Users\Scott\Documents\My Projects\CdkTesting\]
  <PROJECT_PATH>  The paths to the projects to add to the solution.

Options:
  --in-root                                Place project in root of the solution, rather than creating a solution
                                           folder.
  -s, --solution-folder <solution-folder>  The destination solution folder path to add the projects to.
  -?, -h, --help                           Show command line help.

Could not add project CdkTesting.csproj to solution CdkTesting.sln. Error code: 1

Reproduction Steps

Run 'cdk init app --language csharp' from a directory with a space in the path

What did you expect to happen?

A project to be created

What actually happened?

Loud noises and explosions

CDK CLI Version

2.10.0 (build e5b301f)

Framework Version

No response

Node.js Version

v12.22.7

OS

Windows

Language

.NET

Language Version

C#

Other information

Moving to a directory without a space in the path solved the issue.

The text was updated successfully, but these errors were encountered:

When dotnet command is invoked, if arguments are given with spaces unescaped, it interprets that as the start of second command. In this case, when csharp project is initialized, `dotnet sln` command is invoked with slnPath and fsprojPath. Spaces in `slnPath` and `fsprojPath` should be escaped before providing them as argument to dotnet command Fixes aws#18803 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of t he Apache-2.0 license*

bhargav50 · 2022-02-12T19:45:40Z

Hello @ryparker @rix0rrr , I have a question about this PR.
In this specific scenario, the source directory needs to have a space in the name. Shall I create one more integration test for this or a unit test with child_process.spawn function stubbed?

ajgoldenwings · 2022-06-07T16:36:18Z

Thank you @bhargav50 for getting a fix created. I have also ran into this and just removed the spaces from my explorer as a quick fix for the time being.

A v1 app or library cannot be created from the v2 cli. This cleans up the v1 init template code. This is stupidly long because of the amount of files deleted and moved so here's a rundown of the changes: - v1 templates deleted (github is showing some of these as renamed because they were duplicates of the v2 files that did get moved) - v2 templates removed from `v2` folder and moved directly under `init-templates` - hook files imports updated (another place where it shows the change to v1 instead of v2 because the contents were the same) for templates and sample apps - `init.ts`: updated file paths to flattened directory - `init.test.ts`: - updated tests to only run for v2 templates - added test for `fsharp` since it was missing - updated .NET tests to look in the contents of the `.sln` file for the project information. I noticed that this test sometimes still passed when the `init` actually failed. Note: This is the first of two PRs to fix the bug for creating .NET projects with spaces in the file path (issue #18803). This PR was done separately so the bug fix didn't get lost in the 300 file changes due to the cleanup. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

…space When running or with a space in the path to the project, init will fail. This fix adds in handling for spaces and other special characters in the filepath for both windows systems and posix systems. Tests have been added for posix and manual testing was performed on a windows machine. Closes issue #18803.

A v1 app or library cannot be created from the v2 cli. This cleans up the v1 init template code. This is stupidly long because of the amount of files deleted and moved so here's a rundown of the changes: - v1 templates deleted (github is showing some of these as renamed because they were duplicates of the v2 files that did get moved) - v2 templates removed from `v2` folder and moved directly under `init-templates` - hook files imports updated (another place where it shows the change to v1 instead of v2 because the contents were the same) for templates and sample apps - `init.ts`: updated file paths to flattened directory - `init.test.ts`: - updated tests to only run for v2 templates - added test for `fsharp` since it was missing - updated .NET tests to look in the contents of the `.sln` file for the project information. I noticed that this test sometimes still passed when the `init` actually failed. Note: This is the first of two PRs to fix the bug for creating .NET projects with spaces in the file path (issue aws#18803). This PR was done separately so the bug fix didn't get lost in the 300 file changes due to the cleanup. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

…space When running or with a space in the path to the project, init will fail. This fix adds in handling for spaces and other special characters in the filepath for both windows systems and posix systems. Tests have been added for posix and manual testing was performed on a windows machine. Closes issue #18803.

…ins space (#21049) When running `cdk init --language=csharp` or `cdk init --language=fsharp` with one or more spaces in the path to the project, `init` will fail. This fix adds in handling for spaces and other special characters in the file path for both windows systems and posix systems. This PR moves the temporary hook directory to the same directory as the source directory so that it can use the local `os.ts` file and other dependencies. `ShellOptions` was also removed because it wasn't used. Tests have been added for posix and manual testing was performed on a windows machine. Closes issue #18803. ---- ### All Submissions: *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

…ins space (aws#21049) When running `cdk init --language=csharp` or `cdk init --language=fsharp` with one or more spaces in the path to the project, `init` will fail. This fix adds in handling for spaces and other special characters in the file path for both windows systems and posix systems. This PR moves the temporary hook directory to the same directory as the source directory so that it can use the local `os.ts` file and other dependencies. `ShellOptions` was also removed because it wasn't used. Tests have been added for posix and manual testing was performed on a windows machine. Closes issue aws#18803. ---- ### All Submissions: *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

scottiemc7 added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Feb 2, 2022

github-actions bot added the package/tools Related to AWS CDK Tools or CLI label Feb 2, 2022

github-actions bot assigned rix0rrr Feb 2, 2022

ryparker added the p2 label Feb 2, 2022

rix0rrr added effort/small Small work item – less than a day of effort good first issue Related to contributions. See CONTRIBUTING.md p1 and removed p2 needs-triage This issue or PR still needs to be triaged. labels Feb 8, 2022

rix0rrr removed their assignment Feb 8, 2022

bhargav50 mentioned this issue Feb 12, 2022

fix(aws-cdk): escape spaces while invoking dotnet command #18957

Closed

TheRealAmazonKendra self-assigned this May 25, 2022

TheRealAmazonKendra mentioned this issue Jul 6, 2022

chore(init-templates): remove v1 init templates #21019

Merged

TheRealAmazonKendra mentioned this issue Jul 8, 2022

fix(init-templates): csharp and fsharp app init fails when path contains space #21049

Merged

vinayak-kukreja assigned vinayak-kukreja and unassigned vinayak-kukreja and TheRealAmazonKendra Apr 24, 2024

vinayak-kukreja assigned TheRealAmazonKendra May 7, 2024

vinayak-kukreja removed their assignment May 7, 2024

rix0rrr unassigned TheRealAmazonKendra Nov 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cdk init app: space causes failure #18803

cdk init app: space causes failure #18803

scottiemc7 commented Feb 2, 2022

bhargav50 commented Feb 12, 2022 •

edited

Loading

ajgoldenwings commented Jun 7, 2022

cdk init app: space causes failure #18803

cdk init app: space causes failure #18803

Comments

scottiemc7 commented Feb 2, 2022

What is the problem?

Reproduction Steps

What did you expect to happen?

What actually happened?

CDK CLI Version

Framework Version

Node.js Version

OS

Language

Language Version

Other information

bhargav50 commented Feb 12, 2022 • edited Loading

ajgoldenwings commented Jun 7, 2022

bhargav50 commented Feb 12, 2022 •

edited

Loading