Skip to content

start of work to add singularity build from Dockerfile support! #889

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.

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
- `DOCKER_USERNAME` and `DOCKER_PASSWORD` supported without `SINGULARITY_` prefix.
- The `--no-mount` flag now accepts the value `bind-paths` to disable mounting of
all `bind path` entries in `singularity.conf.
- ability to build directly from `Dockerfile`

### Bug Fixes

Expand Down
16 changes: 14 additions & 2 deletions LICENSE_DEPENDENCIES.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ The dependencies and their licenses are as follows:

**License URL:** <https://github.com/containerd/containerd/blob/master/LICENSE>

## github.com/containerd/typeurl

**License:** Apache-2.0

**License URL:** <https://github.com/containerd/typeurl/blob/master/LICENSE>

## github.com/containernetworking/cni

**License:** Apache-2.0
Expand Down Expand Up @@ -137,6 +143,12 @@ The dependencies and their licenses are as follows:

**License URL:** <https://github.com/matttproud/golang_protobuf_extensions/blob/master/pbutil/LICENSE>

## github.com/moby/buildkit

**License:** Apache-2.0

**License URL:** <https://github.com/moby/buildkit/blob/master/LICENSE>

## github.com/moby/locker

**License:** Apache-2.0
Expand Down Expand Up @@ -365,11 +377,11 @@ The dependencies and their licenses are as follows:

**License URL:** <https://github.com/cyphar/filepath-securejoin/blob/master/LICENSE>

## github.com/gogo/protobuf/proto
## github.com/gogo/protobuf

**License:** BSD-3-Clause

**License URL:** <https://github.com/gogo/protobuf/blob/master/proto/LICENSE>
**License URL:** <https://github.com/gogo/protobuf/blob/master/LICENSE>

## github.com/golang/protobuf

Expand Down
17 changes: 9 additions & 8 deletions docs/content.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,15 @@ Enterprise Performance Computing (EPC)`

BUILD SPEC:

The build spec target is a definition (def) file, local image, or URI that can
be used to create a Singularity container. Several different local target
formats exist:

def file : This is a recipe for building a container (examples below)
directory: A directory structure containing a (ch)root file system
image: A local image on your machine (will convert to sif if
it is legacy format)
The build spec target is a definition (def) file, local image, a Dockerfile
(with more limited support) or URI that can be used to create a Singularity
container. Several different local target formats exist:

def file : This is a recipe for building a container (examples below)
Dockerfile : with support for ADD/COPY/FROM/RUN/ENTRYPOINT/CMD/LABEL/ENV
directory: : A directory structure containing a (ch)root file system
image: : A local image on your machine (will convert to sif if
it is legacy format)

Targets can also be remote and defined by a URI of the following formats:

Expand Down
4 changes: 3 additions & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ require (
github.com/go-log/log v0.2.0
github.com/google/uuid v1.3.0
github.com/gosimple/slug v1.12.0
github.com/moby/buildkit v0.10.3
github.com/moby/term v0.0.0-20210619224110-3f7ff695adc6
github.com/opencontainers/go-digest v1.0.0
github.com/opencontainers/image-spec v1.0.3-0.20211202193544-a5463b7f9c84
Expand Down Expand Up @@ -65,6 +66,7 @@ require (
github.com/cespare/xxhash/v2 v2.1.2 // indirect
github.com/cilium/ebpf v0.7.0 // indirect
github.com/containerd/cgroups v1.0.3 // indirect
github.com/containerd/typeurl v1.0.2 // indirect
github.com/containers/libtrust v0.0.0-20200511145503-9c3a6c22cd9a // indirect
github.com/containers/ocicrypt v1.1.4-0.20220428134531-566b808bdf6f // indirect
github.com/containers/storage v1.40.0 // indirect
Expand Down Expand Up @@ -106,7 +108,7 @@ require (
github.com/matttproud/golang_protobuf_extensions v1.0.2-0.20181231171920-c182affec369 // indirect
github.com/miekg/pkcs11 v1.1.1 // indirect
github.com/moby/locker v1.0.1 // indirect
github.com/moby/sys/mount v0.2.0 // indirect
github.com/moby/sys/mount v0.3.0 // indirect
github.com/moby/sys/mountinfo v0.6.1 // indirect
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.2 // indirect
Expand Down
546 changes: 542 additions & 4 deletions go.sum

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion internal/pkg/build/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,8 @@ func MakeAllDefs(spec string) ([]types.Definition, error) {
}
defer defFile.Close()

d, err := parser.All(defFile)
// The Dockerfile parser needs to read the raw file
d, err := parser.All(defFile, spec)
if err != nil {
return nil, fmt.Errorf("while parsing definition: %s: %v", spec, err)
}
Expand Down
2 changes: 1 addition & 1 deletion internal/pkg/build/sources/conveyorPacker_scratch_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import (
"github.com/sylabs/singularity/pkg/build/types/parser"
)

const scratchDef = "../../../../pkg/build/types/parser/testdata_good/scratch/scratch"
const scratchDef = "../../../../pkg/build/types/parser/deffile_test/testdata_good/scratch/scratch"

func TestScratchConveyor(t *testing.T) {
if testing.Short() {
Expand Down
2 changes: 1 addition & 1 deletion pkg/build/types/definition_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ func TestNewDefinitionFromJSON(t *testing.T) {
{JSON: `{"Key1": "Value1", "Key2": "Value2."}`, shouldPass: true},
}

const singularityJSON = "parser/testdata_good/docker/docker.json"
const singularityJSON = "parser/deffile_test/testdata_good/docker/docker.json"
// We do not have a valid example file that we can use to reach the corner cases, so we define a fake JSON
const validSingularityJSON = `
{
Expand Down
58 changes: 41 additions & 17 deletions pkg/build/types/parser/deffile.go
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,23 @@ func getSectionName(line string) string {
return lineSplit[0]
}

// parseFileLin is a shared function to get a src, dest from a single line
func parseFileLine(line string) (string, string) {
var src, dst string
// Split at space, but not within double quotes
lineSubs := fileSplitter.FindAllString(line, -1)
if len(lineSubs) < 2 {
src = strings.TrimSpace(lineSubs[0])
dst = ""
} else {
src = strings.TrimSpace(lineSubs[0])
dst = strings.TrimSpace(lineSubs[1])
}
src = strings.Trim(src, "\"")
dst = strings.Trim(dst, "\"")
return src, dst
}

// parseTokenSection into appropriate components to be placed into a types.Script struct
func parseTokenSection(tok string, sections map[string]*types.Script, files *[]types.Files, appOrder *[]string) error {
split := strings.SplitN(tok, "\n", 2)
Expand All @@ -156,18 +173,7 @@ func parseTokenSection(tok string, sections map[string]*types.Script, files *[]t
if line = strings.TrimSpace(line); line == "" || strings.Index(line, "#") == 0 {
continue
}
var src, dst string
// Split at space, but not within double quotes
lineSubs := fileSplitter.FindAllString(line, -1)
if len(lineSubs) < 2 {
src = strings.TrimSpace(lineSubs[0])
dst = ""
} else {
src = strings.TrimSpace(lineSubs[0])
dst = strings.TrimSpace(lineSubs[1])
}
src = strings.Trim(src, "\"")
dst = strings.Trim(dst, "\"")
src, dst := parseFileLine(line)
f.Files = append(f.Files, types.FileTransport{Src: src, Dst: dst})
}

Expand Down Expand Up @@ -448,16 +454,33 @@ func ParseDefinitionFile(r io.Reader) (d types.Definition, err error) {
// All receives a reader from a definition file
// and parses it into a slice of Definition structs or returns error if
// an error is encounter while parsing
func All(r io.Reader) ([]types.Definition, error) {
var stages []types.Definition

func All(r io.Reader, spec string) ([]types.Definition, error) {
raw, err := ioutil.ReadAll(r)
if err != nil {
return nil, fmt.Errorf("while attempting to read in definition: %v", err)
}

// copy raw data for parsing
buf := raw

// Determine if Singularity recipe (or Docker)
dockerRgx := regexp.MustCompile(`(?mi)^FROM `)
dfrom := dockerRgx.FindAllIndex(buf, -1)

// If we found a FROM with space, assume Dockerfile
if len(dfrom) > 0 {
return ParseDockerfile(spec, raw)
}
return ParseSingularityDefinition(raw)
}

// ParseSingularityDefinition breaks a buffer into sections (stages) and returns them parsed
func ParseSingularityDefinition(raw []byte) ([]types.Definition, error) {
var stages []types.Definition

// copy raw data for parsing
buf := raw

rgx := regexp.MustCompile(`(?mi)^bootstrap:`)
i := rgx.FindAllIndex(buf, -1)

Expand All @@ -474,6 +497,7 @@ func All(r io.Reader) ([]types.Definition, error) {
// handles case of no header
splitBuf = append([][]byte{buf[:]}, splitBuf...)

// Second attempt to quit if everything empty!
if len(splitBuf) == 0 {
return nil, errEmptyDefinition
}
Expand All @@ -483,6 +507,8 @@ func All(r io.Reader) ([]types.Definition, error) {
continue
}

// Both regular definition parser and Docker return
// equivalent sections to be further processed
d, err := ParseDefinitionFile(bytes.NewReader(stage))
if err != nil {
if err == errEmptyDefinition {
Expand All @@ -493,10 +519,8 @@ func All(r io.Reader) ([]types.Definition, error) {

stages = append(stages, d)
}

// set raw of last stage to be entire specification
stages[len(stages)-1].Raw = raw

return stages, nil
}

Expand Down
Loading