Skip to content

Allow customizing CLI locations #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Apr 24, 2023
Merged

Allow customizing CLI locations #225

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8b7913b
Allow passing in binary source
code-asher Apr 18, 2023
50ced03
Add settings page for CLI locations
code-asher Apr 19, 2023
3ab88be
Remove unused message
code-asher Apr 18, 2023
5164aff
Propagate non-zero exit code as exceptions
code-asher Apr 19, 2023
7201fc1
Load workspaces after downloading CLI
code-asher Apr 20, 2023
a1929f1
Check that CLI downloads the first time
code-asher Apr 20, 2023
36500b5
Simplify setting execute bit
code-asher Apr 21, 2023
cdc569a
Catch trying to create a directory at/under non-directory
code-asher Apr 21, 2023
a26d796
Make CLI destination dir required
code-asher Apr 24, 2023
68e9d07
Update comment on read-only directories
code-asher Apr 24, 2023
aa54370
Add real permission tests for Windows
code-asher Apr 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Add real permission tests for Windows
  • Loading branch information
@code-asher
code-asher committed Apr 24, 2023
commit aa54370608a9c6fd9bdcfad136dcf023d1dd59a3
94 changes: 67 additions & 27 deletions src/test/groovy/PathExtensionsTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,56 @@ import spock.lang.Unroll

import java.nio.file.Files
import java.nio.file.Path
import java.nio.file.attribute.AclEntry
import java.nio.file.attribute.AclEntryPermission
import java.nio.file.attribute.AclEntryType
import java.nio.file.attribute.AclFileAttributeView

@Unroll
class PathExtensionsTest extends Specification {
@Shared
private Path tmpdir = Path.of(System.getProperty("java.io.tmpdir"))
@Shared
private Path unwritableFile = tmpdir.resolve("coder-gateway-test/path-extensions/unwritable/file")
@Shared
private Path writableFile = tmpdir.resolve("coder-gateway-test/path-extensions/writable-file")
private Path tmpdir = Path.of(System.getProperty("java.io.tmpdir")).resolve("coder-gateway-test/path-extensions/")

private void setWindowsPermissions(Path path) {
AclFileAttributeView view = Files.getFileAttributeView(path, AclFileAttributeView.class)
AclEntry entry = AclEntry.newBuilder()
.setType(AclEntryType.DENY)
.setPrincipal(view.getOwner())
.setPermissions(AclEntryPermission.WRITE_DATA)
.build()
List<AclEntry> acl = view.getAcl()
acl.set(0, entry)
view.setAcl(acl)
}

void setupSpec() {
// TODO: On Windows setWritable() only sets read-only; how do we set
// actual permissions? Initially I tried an existing dir like WINDIR
// which worked locally but in CI that is writable for some reason.
if (unwritableFile.parent.toFile().exists()) {
unwritableFile.parent.toFile().setWritable(true)
unwritableFile.parent.toFile().deleteDir()
// Clean up from the last run, if any.
tmpdir.toFile().deleteDir()

// Push out the test files.
for (String dir in ["read-only-dir", "no-permissions-dir"]) {
Files.createDirectories(tmpdir.resolve(dir))
tmpdir.resolve(dir).resolve("file").toFile().write("")
}
for (String file in ["read-only-file", "writable-file", "no-permissions-file"]) {
tmpdir.resolve(file).toFile().write("")
}

// On Windows `File.setWritable()` only sets read-only, not permissions
// so on other platforms "read-only" is the same as "no permissions".
tmpdir.resolve("read-only-file").toFile().setWritable(false)
tmpdir.resolve("read-only-dir").toFile().setWritable(false)

// Create files without actual write permissions on Windows (not just
// read-only). On other platforms this is the same as above.
tmpdir.resolve("no-permissions-dir/file").toFile().write("")
if (System.getProperty("os.name").toLowerCase().contains("windows")) {
setWindowsPermissions(tmpdir.resolve("no-permissions-file"))
setWindowsPermissions(tmpdir.resolve("no-permissions-dir"))
} else {
tmpdir.resolve("no-permissions-file").toFile().setWritable(false)
tmpdir.resolve("no-permissions-dir").toFile().setWritable(false)
}
Files.createDirectories(unwritableFile.parent)
unwritableFile.toFile().write("text")
writableFile.toFile().write("text")
unwritableFile.toFile().setWritable(false)
unwritableFile.parent.toFile().setWritable(false)
}

def "canCreateDirectory"() {
Expand All @@ -39,20 +66,33 @@ class PathExtensionsTest extends Specification {

where:
path | expected
unwritableFile | false
unwritableFile.resolve("probably/nonexistent") | false
// TODO: Java reports read-only directories on Windows as writable.
unwritableFile.parent.resolve("probably/nonexistent") | System.getProperty("os.name").toLowerCase().contains("windows")
writableFile | false
writableFile.parent | true
writableFile.resolve("nested/under/file") | false
writableFile.parent.resolve("nested/under/dir") | true
Path.of("relative to project") | true
tmpdir.resolve("./foo/bar/../../coder-gateway-test/path-extensions") | true
// A file is not valid for directory creation regardless of writability.
tmpdir.resolve("read-only-file") | false
tmpdir.resolve("read-only-file/nested/under/file") | false
tmpdir.resolve("writable-file") | false
tmpdir.resolve("writable-file/nested/under/file") | false
tmpdir.resolve("read-only-dir/file") | false
tmpdir.resolve("no-permissions-dir/file") | false

// Windows: can create under read-only directories.
tmpdir.resolve("read-only-dir") | System.getProperty("os.name").toLowerCase().contains("windows")
tmpdir.resolve("read-only-dir/nested/under/dir") | System.getProperty("os.name").toLowerCase().contains("windows")

// Cannot create under a directory without permissions.
tmpdir.resolve("no-permissions-dir") | false
tmpdir.resolve("no-permissions-dir/nested/under/dir") | false

// Can create under a writable directory.
tmpdir | true
tmpdir.resolve("some/nested/non-existent/path") | true
tmpdir.resolve("./foo/bar/../../coder-gateway-test/path-extensions") | true
tmpdir.resolve("nested/under/dir") | true
tmpdir.resolve("with space") | true

// Config/data directories should be fine.
CoderCLIManager.getConfigDir() | true
CoderCLIManager.getDataDir() | true

// Relative paths can work as well.
Path.of("relative/to/project") | true
}
}