Skip to content

Commit

Permalink
devpkg: make FlakeInstallable.Outputs a string (#1599)
Browse files Browse the repository at this point in the history 
Change `ParseInstallable.Outputs` from a `[]string` to a `string` and
move the splitting logic to a `SplitOutputs` method. This makes
installables directly comparable with `==` and usable as map keys, which
is something we currently do a bunch using unparsed installable strings.
  • Loading branch information
@gcurtis
gcurtis authored Nov 1, 2023
1 parent 439f2c4 commit a4d901c
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 64 deletions.
53 changes: 35 additions & 18 deletions internal/devpkg/flakeref.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package devpkg
import (
"net/url"
"path"
"slices"
"strings"

"go.jetpack.io/devbox/internal/redact"
Expand Down Expand Up @@ -407,6 +408,16 @@ func buildQueryString(keyval ...string) string {
return query.Encode()
}

// Special values for FlakeInstallable.Outputs.
const (
// DefaultOutputs specifies that the package-defined default outputs
// should be installed.
DefaultOutputs = ""

// AllOutputs specifies that all package outputs should be installed.
AllOutputs = "*"
)

// FlakeInstallable is a Nix command line argument that specifies how to install
// a flake. It can be a plain flake reference, or a flake reference with an
// attribute path and/or output specification.
Expand All @@ -429,9 +440,9 @@ func buildQueryString(keyval ...string) string {
type FlakeInstallable struct {
Ref FlakeRef
AttrPath string
Outputs []string

raw string
raw string
Outputs string
}

// ParseFlakeInstallable parses a flake installable. The string s must contain a
Expand All @@ -445,11 +456,8 @@ func ParseFlakeInstallable(raw string) (FlakeInstallable, error) {
// The output spec must be parsed and removed first, otherwise it will
// be parsed as part of the flakeref's URL fragment.
install := FlakeInstallable{raw: raw}
before, after := splitOutputSpec(raw)
if after != "" {
install.Outputs = strings.Split(after, ",")
}
raw = before
raw, install.Outputs = splitOutputSpec(raw)
install.Outputs = strings.Join(install.SplitOutputs(), ",") // clean the outputs

// Interpret installables with path-style flakerefs as URLs to extract
// the attribute path (fragment). This means that path-style flakerefs
Expand All @@ -468,20 +476,29 @@ func ParseFlakeInstallable(raw string) (FlakeInstallable, error) {
return install, nil
}

// AllOutputs returns true if the installable specifies all outputs with the
// "^*" syntax.
func (f FlakeInstallable) AllOutputs() bool {
for _, out := range f.Outputs {
// SplitOutputs splits and sorts the comma-separated list of outputs. It skips
// any empty outputs. If one or more of the outputs is a "*", then the result
// will be a slice with a single "*" element.
func (f FlakeInstallable) SplitOutputs() []string {
if f.Outputs == "" {
return []string{}
}

split := strings.Split(f.Outputs, ",")
i := 0
for _, out := range split {
// A wildcard takes priority over any other outputs.
if out == "*" {
return true
return []string{"*"}
}
if out != "" {
split[i] = out
i++
}
}
return false
}

// DefaultOutputs returns true if the installable does not specify any outputs.
func (f FlakeInstallable) DefaultOutputs() bool {
return len(f.Outputs) == 0
split = split[:i]
slices.Sort(split)
return split
}

// String returns the raw installable string as given to ParseFlakeInstallable.
Expand Down
56 changes: 10 additions & 46 deletions internal/devpkg/flakeref_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -237,22 +237,22 @@ func TestParseFlakeInstallable(t *testing.T) {

".": {Ref: FlakeRef{Type: "path", Path: "."}},
".#app": {AttrPath: "app", Ref: FlakeRef{Type: "path", Path: "."}},
".#app^out": {AttrPath: "app", Outputs: []string{"out"}, Ref: FlakeRef{Type: "path", Path: "."}},
".#app^out,lib": {AttrPath: "app", Outputs: []string{"out", "lib"}, Ref: FlakeRef{Type: "path", Path: "."}},
".#app^*": {AttrPath: "app", Outputs: []string{"*"}, Ref: FlakeRef{Type: "path", Path: "."}},
".^*": {Outputs: []string{"*"}, Ref: FlakeRef{Type: "path", Path: "."}},
".#app^out": {AttrPath: "app", Outputs: "out", Ref: FlakeRef{Type: "path", Path: "."}},
".#app^out,lib": {AttrPath: "app", Outputs: "lib,out", Ref: FlakeRef{Type: "path", Path: "."}},
".#app^*": {AttrPath: "app", Outputs: "*", Ref: FlakeRef{Type: "path", Path: "."}},
".^*": {Outputs: "*", Ref: FlakeRef{Type: "path", Path: "."}},

"./flake": {Ref: FlakeRef{Type: "path", Path: "./flake"}},
"./flake#app": {AttrPath: "app", Ref: FlakeRef{Type: "path", Path: "./flake"}},
"./flake#app^out": {AttrPath: "app", Outputs: []string{"out"}, Ref: FlakeRef{Type: "path", Path: "./flake"}},
"./flake#app^out,lib": {AttrPath: "app", Outputs: []string{"out", "lib"}, Ref: FlakeRef{Type: "path", Path: "./flake"}},
"./flake^out": {Outputs: []string{"out"}, Ref: FlakeRef{Type: "path", Path: "./flake"}},
"./flake#app^out": {AttrPath: "app", Outputs: "out", Ref: FlakeRef{Type: "path", Path: "./flake"}},
"./flake#app^out,lib": {AttrPath: "app", Outputs: "lib,out", Ref: FlakeRef{Type: "path", Path: "./flake"}},
"./flake^out": {Outputs: "out", Ref: FlakeRef{Type: "path", Path: "./flake"}},

"indirect": {Ref: FlakeRef{Type: "indirect", ID: "indirect"}},
"nixpkgs#app": {AttrPath: "app", Ref: FlakeRef{Type: "indirect", ID: "nixpkgs"}},
"nixpkgs#app^out": {AttrPath: "app", Outputs: []string{"out"}, Ref: FlakeRef{Type: "indirect", ID: "nixpkgs"}},
"nixpkgs#app^out,lib": {AttrPath: "app", Outputs: []string{"out", "lib"}, Ref: FlakeRef{Type: "indirect", ID: "nixpkgs"}},
"nixpkgs^out": {Outputs: []string{"out"}, Ref: FlakeRef{Type: "indirect", ID: "nixpkgs"}},
"nixpkgs#app^out": {AttrPath: "app", Outputs: "out", Ref: FlakeRef{Type: "indirect", ID: "nixpkgs"}},
"nixpkgs#app^out,lib": {AttrPath: "app", Outputs: "lib,out", Ref: FlakeRef{Type: "indirect", ID: "nixpkgs"}},
"nixpkgs^out": {Outputs: "out", Ref: FlakeRef{Type: "indirect", ID: "nixpkgs"}},

"%23#app": {AttrPath: "app", Ref: FlakeRef{Type: "indirect", ID: "#"}},
"./%23#app": {AttrPath: "app", Ref: FlakeRef{Type: "path", Path: "./#"}},
Expand Down Expand Up @@ -280,42 +280,6 @@ func TestParseFlakeInstallable(t *testing.T) {
}
}

func TestFlakeInstallableDefaultOutputs(t *testing.T) {
install := FlakeInstallable{Outputs: nil}
if !install.DefaultOutputs() {
t.Errorf("DefaultOutputs() = false for nil outputs slice, want true")
}

install = FlakeInstallable{Outputs: []string{}}
if !install.DefaultOutputs() {
t.Errorf("DefaultOutputs() = false for empty outputs slice, want true")
}

install = FlakeInstallable{Outputs: []string{"out"}}
if install.DefaultOutputs() {
t.Errorf("DefaultOutputs() = true for %v, want false", install.Outputs)
}
}

func TestFlakeInstallableAllOutputs(t *testing.T) {
install := FlakeInstallable{Outputs: []string{"*"}}
if !install.AllOutputs() {
t.Errorf("AllOutputs() = false for %v, want true", install.Outputs)
}
install = FlakeInstallable{Outputs: []string{"out", "*"}}
if !install.AllOutputs() {
t.Errorf("AllOutputs() = false for %v, want true", install.Outputs)
}
install = FlakeInstallable{Outputs: nil}
if install.AllOutputs() {
t.Errorf("AllOutputs() = true for nil outputs slice, want false")
}
install = FlakeInstallable{Outputs: []string{}}
if install.AllOutputs() {
t.Errorf("AllOutputs() = true for empty outputs slice, want false")
}
}

func TestBuildQueryString(t *testing.T) {
defer func() {
if r := recover(); r == nil {
Expand Down

0 comments on commit a4d901c

Please sign in to comment.