Add support for SBT #314
Open
Add support for SBT #314
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zombiezen
reviewed
Jun 1, 2021
| if got := versionOutput.String(); !strings.Contains(got, version) { | ||
| t.Errorf("sbt --version output does not include %q", version) | ||
| } | ||
| } |
There was a problem hiding this comment.
It would be good to have some unit tests for the sbtDownloadURL function, like for the Java buildpack (but doesn't need to be nearly as extensive):
yb/internal/buildpack/openjdk_test.go
Lines 48 to 141 in 03eed7b
| func TestSBT(t *testing.T) { | ||
| const version = "1.5.2" | ||
| ctx := testlog.WithTB(context.Background(), t) | ||
| // TODO(johnewart): SBT depends on Java -- see Ross's comment in sbt tests |
There was a problem hiding this comment.
Suggested change
| // TODO(johnewart): SBT depends on Java -- see Ross's comment in sbt tests | |
| // TODO(johnewart): SBT depends on Java -- see Ross's comment in Ant tests |
Comment on lines
+66
to
+111
| func sbtDownloadURL(version string, desc *biome.Descriptor) (string, error) { | ||
| vparts := strings.SplitN(version, "+", 2) | ||
| subVersion := "" | ||
| if len(vparts) > 1 { | ||
| subVersion = vparts[1] | ||
| version = vparts[0] | ||
| } | ||
|
|
||
| parts := strings.Split(version, ".") | ||
|
|
||
| majorVersion, err := convertVersionPiece(parts, 0) | ||
| if err != nil { | ||
| return "", fmt.Errorf("parse jdk version %q: major: %w", version, err) | ||
| } | ||
| minorVersion, err := convertVersionPiece(parts, 1) | ||
| if err != nil { | ||
| return "", fmt.Errorf("parse jdk version %q: minor: %w", version, err) | ||
| } | ||
| patchVersion, err := convertVersionPiece(parts, 2) | ||
| if err != nil { | ||
| return "", fmt.Errorf("parse jdk version %q: patch: %w", version, err) | ||
| } | ||
|
|
||
| urlPattern := "https://github.com/sbt/sbt/releases/download/v{{ .MajorVersion }}.{{ .MinorVersion }}.{{ .PatchVersion }}/sbt-{{ .MajorVersion }}.{{ .MinorVersion }}.{{ .PatchVersion }}.tgz" | ||
|
|
||
| var data struct { | ||
| OS string | ||
| Arch string | ||
| MajorVersion int64 | ||
| MinorVersion int64 | ||
| PatchVersion int64 | ||
| SubVersion string // not always an int, sometimes a float | ||
| } | ||
| data.OS = map[string]string{ | ||
| biome.Linux: "linux", | ||
| biome.MacOS: "mac", | ||
| }[desc.OS] | ||
| if data.OS == "" { | ||
| return "", fmt.Errorf("unsupported os %s", desc.OS) | ||
| } | ||
| data.MajorVersion = majorVersion | ||
| data.MinorVersion = minorVersion | ||
| data.PatchVersion = patchVersion | ||
| data.SubVersion = subVersion | ||
| return templateToString(urlPattern, data) | ||
| } |
There was a problem hiding this comment.
IIUC, the URL is only dependent on version, right? I think this function can be simplified to pass the version string through verbatim.
Suggested change
| func sbtDownloadURL(version string, desc *biome.Descriptor) (string, error) { | |
| vparts := strings.SplitN(version, "+", 2) | |
| subVersion := "" | |
| if len(vparts) > 1 { | |
| subVersion = vparts[1] | |
| version = vparts[0] | |
| } | |
| parts := strings.Split(version, ".") | |
| majorVersion, err := convertVersionPiece(parts, 0) | |
| if err != nil { | |
| return "", fmt.Errorf("parse jdk version %q: major: %w", version, err) | |
| } | |
| minorVersion, err := convertVersionPiece(parts, 1) | |
| if err != nil { | |
| return "", fmt.Errorf("parse jdk version %q: minor: %w", version, err) | |
| } | |
| patchVersion, err := convertVersionPiece(parts, 2) | |
| if err != nil { | |
| return "", fmt.Errorf("parse jdk version %q: patch: %w", version, err) | |
| } | |
| urlPattern := "https://github.com/sbt/sbt/releases/download/v{{ .MajorVersion }}.{{ .MinorVersion }}.{{ .PatchVersion }}/sbt-{{ .MajorVersion }}.{{ .MinorVersion }}.{{ .PatchVersion }}.tgz" | |
| var data struct { | |
| OS string | |
| Arch string | |
| MajorVersion int64 | |
| MinorVersion int64 | |
| PatchVersion int64 | |
| SubVersion string // not always an int, sometimes a float | |
| } | |
| data.OS = map[string]string{ | |
| biome.Linux: "linux", | |
| biome.MacOS: "mac", | |
| }[desc.OS] | |
| if data.OS == "" { | |
| return "", fmt.Errorf("unsupported os %s", desc.OS) | |
| } | |
| data.MajorVersion = majorVersion | |
| data.MinorVersion = minorVersion | |
| data.PatchVersion = patchVersion | |
| data.SubVersion = subVersion | |
| return templateToString(urlPattern, data) | |
| } | |
| func sbtDownloadURL(version string) (string, error) { | |
| const urlPattern = "https://github.com/sbt/sbt/releases/download/v{{ .Version }}/sbt-{{ .Version }}.tgz" | |
| var data struct { | |
| Version string | |
| } | |
| data.Version = url.PathEscape(version) | |
| return templateToString(urlPattern, data) | |
| } |
Comment on lines
+34
to
+35
| parentDir := os.TempDir() | ||
| socketDir, err := ioutil.TempDir(parentDir, "*-ybsbt") |
There was a problem hiding this comment.
This unfortunately won't work on Docker-based builds, since it creates the directory on the host instead of inside the biome.
Would it be appropriate to use a directory inside the biome home? Perhaps sys.Biome.JoinPath(sys.Biome.Dirs().Tools, "sbt-server")?
| if err != nil { | ||
| log.Errorf(ctx, "Error creating directory for SBT sockets: %v", err) | ||
| } | ||
| log.Infof(ctx, "SBT will use %s as the socket directory", socketDir) |
There was a problem hiding this comment.
I don't think the average user needs to know this information unless something went wrong, so I suggest debug-level log.
Suggested change
| log.Infof(ctx, "SBT will use %s as the socket directory", socketDir) | |
| log.Debugf(ctx, "SBT will use %s as the socket directory", socketDir) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also support
.tgzand.tbz2files in decompression bits