Merge pull request moby#3620 from tonistiigi/sourcemap-lang

Author: jedevc

client/client_test.go

@@ -5805,8 +5805,8 @@ func testSourceMap(t *testing.T, sb integration.Sandbox) {
 	require.NoError(t, err)
 	defer c.Close()
 
-	sm1 := llb.NewSourceMap(nil, "foo", []byte("data1"))
-	sm2 := llb.NewSourceMap(nil, "bar", []byte("data2"))
+	sm1 := llb.NewSourceMap(nil, "foo", "", []byte("data1"))
+	sm2 := llb.NewSourceMap(nil, "bar", "", []byte("data2"))
 
 	st := llb.Scratch().Run(
 		llb.Shlex("not-exist"),
@@ -5860,7 +5860,7 @@ func testSourceMapFromRef(t *testing.T, sb integration.Sandbox) {
 
 	srcState := llb.Scratch().File(
 		llb.Mkfile("foo", 0600, []byte("data")))
-	sm := llb.NewSourceMap(&srcState, "bar", []byte("bardata"))
+	sm := llb.NewSourceMap(&srcState, "bar", "mylang", []byte("bardata"))
 
 	frontend := func(ctx context.Context, c gateway.Client) (*gateway.Result, error) {
 		st := llb.Scratch().File(
@@ -5911,6 +5911,7 @@ func testSourceMapFromRef(t *testing.T, sb integration.Sandbox) {
 	require.Equal(t, 1, len(srcs))
 
 	require.Equal(t, "bar", srcs[0].Info.Filename)
+	require.Equal(t, "mylang", srcs[0].Info.Language)
 	require.Equal(t, []byte("bardata"), srcs[0].Info.Data)
 	require.NotNil(t, srcs[0].Info.Definition)
 

client/llb/definition.go

@@ -70,7 +70,7 @@ func NewDefinitionOp(def *pb.Definition) (*DefinitionOp, error) {
 				state := NewState(op)
 				st = &state
 			}
-			sourceMaps[i] = NewSourceMap(st, info.Filename, info.Data)
+			sourceMaps[i] = NewSourceMap(st, info.Filename, info.Language, info.Data)
 		}
 
 		for dgst, locs := range def.Source.Locations {

client/llb/sourcemap.go

@@ -21,13 +21,16 @@ type SourceMap struct {
 	State      *State
 	Definition *Definition
 	Filename   string
-	Data       []byte
+	// Language should use names defined in https://github.com/github/linguist/blob/v7.24.1/lib/linguist/languages.yml
+	Language string
+	Data     []byte
 }
 
-func NewSourceMap(st *State, filename string, dt []byte) *SourceMap {
+func NewSourceMap(st *State, filename string, lang string, dt []byte) *SourceMap {
 	return &SourceMap{
 		State:    st,
 		Filename: filename,
+		Language: lang,
 		Data:     dt,
 	}
 }
@@ -92,6 +95,7 @@ func (smc *sourceMapCollector) Marshal(ctx context.Context, co ...ConstraintsOpt
 		info := &pb.SourceInfo{
 			Data:     m.Data,
 			Filename: m.Filename,
+			Language: m.Language,
 		}
 
 		if def != nil {

client/llb/state_test.go

@@ -58,8 +58,8 @@ func TestFormattingPatterns(t *testing.T) {
 func TestStateSourceMapMarshal(t *testing.T) {
 	t.Parallel()
 
-	sm1 := NewSourceMap(nil, "foo", []byte("data1"))
-	sm2 := NewSourceMap(nil, "bar", []byte("data2"))
+	sm1 := NewSourceMap(nil, "foo", "lang1", []byte("data1"))
+	sm2 := NewSourceMap(nil, "bar", "lang2", []byte("data2"))
 
 	s := Image(
 		"myimage",
@@ -78,10 +78,12 @@ func TestStateSourceMapMarshal(t *testing.T) {
 	require.Equal(t, 1, len(def.Source.Locations))
 
 	require.Equal(t, "foo", def.Source.Infos[0].Filename)
+	require.Equal(t, "lang1", def.Source.Infos[0].Language)
 	require.Equal(t, []byte("data1"), def.Source.Infos[0].Data)
 	require.Nil(t, def.Source.Infos[0].Definition)
 
 	require.Equal(t, "bar", def.Source.Infos[1].Filename)
+	require.Equal(t, "lang2", def.Source.Infos[1].Language)
 	require.Equal(t, []byte("data2"), def.Source.Infos[1].Data)
 	require.Nil(t, def.Source.Infos[1].Definition)
 

frontend/dockerfile/builder/build.go

@@ -41,7 +41,7 @@ func Build(ctx context.Context, c client.Client) (_ *client.Result, err error) {
 		return nil, capsError
 	}
 
-	src, err := bc.ReadEntrypoint(ctx)
+	src, err := bc.ReadEntrypoint(ctx, "Dockerfile")
 	if err != nil {
 		return nil, err
 	}
@@ -254,6 +254,7 @@ func wrapSource(err error, sm *llb.SourceMap, ranges []parser.Range) error {
 		Info: &pb.SourceInfo{
 			Data:       sm.Data,
 			Filename:   sm.Filename,
+			Language:   sm.Language,
 			Definition: sm.Definition.ToPB(),
 		},
 		Ranges: make([]*pb.Range, 0, len(ranges)),

frontend/dockerfile/errors_test.go

@@ -97,6 +97,7 @@ env bar=baz`,
 			require.Equal(t, 1, len(srcs))
 
 			require.Equal(t, "Dockerfile", srcs[0].Info.Filename)
+			require.Equal(t, "Dockerfile", srcs[0].Info.Language)
 			require.Equal(t, tc.dockerfile, string(srcs[0].Info.Data))
 			require.Equal(t, len(tc.errorLine), len(srcs[0].Ranges))
 			require.NotNil(t, srcs[0].Info.Definition)

frontend/dockerui/config.go

@@ -294,7 +294,7 @@ func (bc *Client) buildContext(ctx context.Context) (*buildContext, error) {
 	return bctx.(*buildContext), nil
 }
 
-func (bc *Client) ReadEntrypoint(ctx context.Context, opts ...llb.LocalOption) (*Source, error) {
+func (bc *Client) ReadEntrypoint(ctx context.Context, lang string, opts ...llb.LocalOption) (*Source, error) {
 	bctx, err := bc.buildContext(ctx)
 	if err != nil {
 		return nil, err
@@ -369,7 +369,7 @@ func (bc *Client) ReadEntrypoint(ctx context.Context, opts ...llb.LocalOption) (
 			return nil, errors.Wrapf(err, "failed to read dockerfile")
 		}
 	}
-	smap := llb.NewSourceMap(src, bctx.filename, dt)
+	smap := llb.NewSourceMap(src, bctx.filename, lang, dt)
 	smap.Definition = def
 
 	dt, err = ref.ReadFile(ctx, client.ReadRequest{
@@ -389,6 +389,7 @@ func (bc *Client) ReadEntrypoint(ctx context.Context, opts ...llb.LocalOption) (
 				opts.SourceInfo = &pb.SourceInfo{
 					Data:       smap.Data,
 					Filename:   smap.Filename,
+					Language:   smap.Language,
 					Definition: smap.Definition.ToPB(),
 				}
 			}

solver/llbsolver/provenance/buildconfig.go

@@ -28,6 +28,7 @@ type Source struct {
 
 type SourceInfo struct {
 	Filename      string                   `json:"filename,omitempty"`
+	Language      string                   `json:"language,omitempty"`
 	Data          []byte                   `json:"data,omitempty"`
 	Definition    []BuildStep              `json:"llbDefinition,omitempty"`
 	DigestMapping map[digest.Digest]string `json:"digestMapping,omitempty"`
@@ -65,6 +66,7 @@ func AddBuildConfig(ctx context.Context, p *ProvenancePredicate, rp solver.Resul
 			s := SourceInfo{
 				Filename:      si.Filename,
 				Data:          si.Data,
+				Language:      si.Language,
 				Definition:    steps,
 				DigestMapping: digestMap(indexes),
 			}