Process project.toml for app source metadata #1231

Haimantika · 2021-07-15T06:04:53Z

Summary

Parsed the file (made changes to project.go)
Wrote the project-metdata. toml file (changes to be found in container_ops.go, container_ops_test.go, lifecycle_execution_test.go and lifecycle_execution.go)

Resolves #1138

Signed-off-by: haimantika mitra <[email protected]>

aemengo

Thanks for helping us out with this 🙏🏾

Let's please not have these types of files as part of the PR (internal/registry/registry468683854).

I made this issue about removing these artifacts after the tests run: #1228

Signed-off-by: haimantika mitra <[email protected]>

…he needs of the issue Signed-off-by: haimantika mitra <[email protected]>

…go.mod and go.sum files Signed-off-by: haimantika mitra <[email protected]>

Signed-off-by: Javier Romero <[email protected]>

Signed-off-by: haimantika mitra <[email protected]>

aemengo · 2021-07-27T20:47:06Z

project/project.go

+func (d *Descriptor) ProjectMetadata() platform.ProjectMetadata {
+	return platform.ProjectMetadata{}
+}
+


As much as I like it, these lines won't be needed in your final implementation, correct?

Nope, we can do without. Maybe I can comment this out,

If something isn't necessary, we delete it, not comment out. 😁

jromero

Made a few change requests but overall the feature looks great!

Also, it looks like there's a minor conflict with build.go. We'll want to resolve that so we can run all the tests on GitHub.

acceptance/acceptance_test.go

jromero · 2021-07-29T20:07:41Z

acceptance/acceptance_test.go

@@ -901,6 +904,9 @@ func testAcceptance(
 						t.Log("sets the run image metadata")
 						assertImage.HasLabelWithData(repoName, "io.buildpacks.lifecycle.metadata", fmt.Sprintf(`"stack":{"runImage":{"image":"%s","mirrors":["%s"]}}}`, runImage, runImageMirror))

+						t.Log("sets the source metadata")
+						assertImage.HasLabelWithData(repoName, "io.buildpacks.project.metadata", fmt.Sprintf(`{"project-metadata":{"source":{"type":"%s","version":{"declared":"%s"},"metadata":{"url":"%s"}}}`, Type, version, metadata))


Suggested change

assertImage.HasLabelWithData(repoName, "io.buildpacks.project.metadata", fmt.Sprintf(`{"project-metadata":{"source":{"type":"%s","version":{"declared":"%s"},"metadata":{"url":"%s"}}}`, Type, version, metadata))

assertImage.HasLabelWithData(repoName, "io.buildpacks.project.metadata", `{"project-metadata":{"source":{"type":"project","version":{"declared":"1.0.2"},"metadata":{"url":"https://github.com/buildpacks/pack"}}}`)

jromero · 2021-07-29T20:09:02Z

acceptance/testdata/mock_app/project.toml

@@ -0,0 +1,3 @@
+[project]
+  version = "1.0.2"
+  source-url = "https://github.com/buildpacks/pack"


Suggested change

source-url = "https://github.com/buildpacks/pack"

source-url = "https://github.com/buildpacks/pack"

I hate this but we should have a new line character at the end of each file. See https://unix.stackexchange.com/q/18743

jromero · 2021-07-29T20:10:47Z

build.go

@@ -19,6 +19,8 @@ import (
 	"github.com/pkg/errors"
 	ignore "github.com/sabhiram/go-gitignore"

+	"github.com/buildpacks/lifecycle/platform"


Import Groups

Imports should be grouped into the following:

Standard library

External libraries

Local packages

jromero · 2021-07-29T20:12:40Z

internal/build/container_ops.go

+// func createReader(src, dst string, uid, gid int, includeRoot bool, fileFilter func(string) bool) (io.ReadCloser, error) {
+// 	fi, err := os.Stat(src)
+// 	if err != nil {
+// 		return nil, err
+// 	}
+
+// 	if fi.IsDir() {
+// 		var mode int64 = -1
+// 		if runtime.GOOS == "windows" {
+// 			mode = 0777
+// 		}
+
+// 		return archive.ReadDirAsTar(src, dst, uid, gid, mode, false, includeRoot, fileFilter), nil
+// 	}
+
+// 	return archive.ReadZipAsTar(src, dst, uid, gid, -1, false, fileFilter), nil
+// }
+


We don't want to commit unused code

Suggested change

// func createReader(src, dst string, uid, gid int, includeRoot bool, fileFilter func(string) bool) (io.ReadCloser, error) {

// fi, err := os.Stat(src)

// if err != nil {

// return nil, err

// }

// if fi.IsDir() {

// var mode int64 = -1

// if runtime.GOOS == "windows" {

// mode = 0777

// }

// return archive.ReadDirAsTar(src, dst, uid, gid, mode, false, includeRoot, fileFilter), nil

// }

// return archive.ReadZipAsTar(src, dst, uid, gid, -1, false, fileFilter), nil

// }

jromero · 2021-07-29T20:16:17Z

internal/build/container_ops.go

@@ -15,6 +15,8 @@ import (
 	"github.com/docker/docker/client"
 	"github.com/pkg/errors"

+	"github.com/buildpacks/lifecycle/platform"


See "Import Groups"

jromero · 2021-07-29T20:16:43Z

internal/build/container_ops_test.go

@@ -20,6 +20,8 @@ import (
 	"github.com/sclevine/spec"
 	"github.com/sclevine/spec/report"

+	"github.com/buildpacks/lifecycle/platform"


See "Import Groups"

jromero · 2021-07-29T20:19:03Z

project.toml

@@ -0,0 +1,3 @@
+[project]
+  version = "1.0.2"
+  source-url = "https://github.com/buildpacks/pack"


nit: "New line" character missing at end of file

jromero · 2021-07-29T20:19:28Z

project/project.go

@@ -5,8 +5,10 @@ import (
 	"path/filepath"

 	"github.com/BurntSushi/toml"
+	//"github.com/docker/docker/api/types/versions"


Suggested change

//"github.com/docker/docker/api/types/versions"

jromero · 2021-07-29T20:20:05Z

project/project.go

+func (d *Descriptor) ProjectMetadata() platform.ProjectMetadata {
+	return platform.ProjectMetadata{}
+}
+


If something isn't necessary, we delete it, not comment out. 😁

Co-authored-by: Javier Romero <[email protected]>

Signed-off-by: haimantika mitra <[email protected]>

codecov · 2021-08-02T18:51:11Z

Codecov Report

Merging #1231 (946e2e6) into main (66a4f32) will decrease coverage by 1.11%.
The diff coverage is 76.20%.

@@            Coverage Diff             @@
##             main    #1231      +/-   ##
==========================================
- Coverage   80.99%   79.88%   -1.10%     
==========================================
  Files         140      140              
  Lines        8534     8568      +34     
==========================================
- Hits         6911     6844      -67     
- Misses       1184     1284     +100     
- Partials      439      440       +1

Flag	Coverage Δ
os_linux	`80.64% <80.00%> (-0.02%)`	⬇️
os_macos	`78.00% <54.29%> (-0.16%)`	⬇️
os_windows	`79.80% <76.20%> (-1.10%)`	⬇️
unit	`80.64% <80.00%> (-0.02%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Haimantika added 2 commits July 7, 2021 19:35

Parsed project descriptor

3c12be1

Signed-off-by: haimantika mitra <[email protected]>

Added project metadata file

a35b2c2

Signed-off-by: haimantika mitra <[email protected]>

Haimantika requested a review from a team as a code owner July 15, 2021 06:04

github-actions bot added this to the 0.20.0 milestone Jul 15, 2021

github-actions bot added the type/enhancement Issue that requests a new feature or improvement. label Jul 15, 2021

aemengo suggested changes Jul 15, 2021

View reviewed changes

Haimantika added 3 commits July 17, 2021 10:22

Removed syntax errors

b30806a

Signed-off-by: haimantika mitra <[email protected]>

Changed the metadata.go and container_ops_test.go file according to t…

d732d44

…he needs of the issue Signed-off-by: haimantika mitra <[email protected]>

Added struct in lifecycle_executor.go and some minute changes on the …

c7a379c

…go.mod and go.sum files Signed-off-by: haimantika mitra <[email protected]>

github-actions bot added the type/chore Issue that requests non-user facing changes. label Jul 17, 2021

jromero and others added 3 commits July 17, 2021 20:24

Fix compiler errors

8c91798

Signed-off-by: Javier Romero <[email protected]>

Formatted

c189f4b

Signed-off-by: haimantika mitra <[email protected]>

Changed path and wrote acceptance test

593a70e

Signed-off-by: haimantika mitra <[email protected]>

jromero modified the milestones: 0.20.0, 0.21.0 Jul 21, 2021

Testing for errors

912a83c

Signed-off-by: haimantika mitra <[email protected]>

github-actions bot modified the milestones: 0.21.0, 0.20.0 Jul 24, 2021

Haimantika added 6 commits July 24, 2021 17:48

Debugging

6201391

Signed-off-by: haimantika mitra <[email protected]>

Fixing errors

e72eef4

Signed-off-by: haimantika mitra <[email protected]>

Fixing error pt 2

a83e8bc

Signed-off-by: haimantika mitra <[email protected]>

Corrected printf to sprintf

496c40d

Signed-off-by: haimantika mitra <[email protected]>

Fixed sprintf and whitespace issue

79a16be

Signed-off-by: haimantika mitra <[email protected]>

New changes with tests working locally

e955e6a

Signed-off-by: haimantika mitra <[email protected]>

aemengo reviewed Jul 27, 2021

View reviewed changes

jromero suggested changes Jul 29, 2021

View reviewed changes

Haimantika and others added 2 commits July 30, 2021 11:58

Update acceptance/acceptance_test.go

9eed9b3

Co-authored-by: Javier Romero <[email protected]>

Applied suggested changes

7f390eb

Signed-off-by: haimantika mitra <[email protected]>

Haimantika force-pushed the Parsedfile-1138 branch from fcbe322 to 7f390eb Compare July 30, 2021 06:50

Solved the conflict

bbcb9e2

Signed-off-by: haimantika mitra <[email protected]>

Haimantika added 7 commits July 30, 2021 16:00

Fixed formatting

2dff56c

Signed-off-by: haimantika mitra <[email protected]>

Corrected the json in acceptance_test.go

9046f76

Signed-off-by: haimantika mitra <[email protected]>

Tried fixing the registry error

7897d8e

Signed-off-by: haimantika mitra <[email protected]>

Changes made in acceptance test

5f0113a

Signed-off-by: haimantika mitra <[email protected]>

Parathesis issue fixing

210c064

Signed-off-by: haimantika mitra <[email protected]>

Re-do changes

3d6b7c1

Signed-off-by: haimantika mitra <[email protected]>

Paranthesis error fixed

946e2e6

Signed-off-by: haimantika mitra <[email protected]>

jromero changed the title ~~Parsed file and added project_metadata.toml file- Issue #1138~~ Process project.toml for app source metadata Aug 9, 2021

jromero removed the type/chore Issue that requests non-user facing changes. label Aug 9, 2021

jromero modified the milestones: 0.20.0, 0.21.0 Aug 9, 2021

jromero mentioned this pull request Aug 9, 2021

Polish/1231 #1249

Merged

jromero merged commit 946e2e6 into buildpacks:main Aug 10, 2021

jromero added the experimental Issue or PR refers to an experimental feature. label Sep 15, 2021

jjbustamante mentioned this pull request Aug 18, 2023

Allow pack to build applications that have their source code at a remote location #1143

Open

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Process project.toml for app source metadata #1231

Process project.toml for app source metadata #1231

Haimantika commented Jul 15, 2021 •

edited by jromero

Loading

aemengo left a comment

aemengo Jul 27, 2021

Haimantika Jul 28, 2021

jromero Jul 29, 2021

jromero left a comment •

edited

Loading

jromero Jul 29, 2021

jromero Jul 29, 2021

jromero Jul 29, 2021

jromero Jul 29, 2021

jromero Jul 29, 2021

jromero Jul 29, 2021

jromero Jul 29, 2021

jromero Jul 29, 2021

jromero Jul 29, 2021

codecov bot commented Aug 2, 2021 •

edited

Loading

	assertImage.HasLabelWithData(repoName, "io.buildpacks.project.metadata", fmt.Sprintf(`{"project-metadata":{"source":{"type":"%s","version":{"declared":"%s"},"metadata":{"url":"%s"}}}`, Type, version, metadata))
	assertImage.HasLabelWithData(repoName, "io.buildpacks.project.metadata", `{"project-metadata":{"source":{"type":"project","version":{"declared":"1.0.2"},"metadata":{"url":"https://github.com/buildpacks/pack"}}}`)

	source-url = "https://github.com/buildpacks/pack"
	source-url = "https://github.com/buildpacks/pack"

Process project.toml for app source metadata #1231

Process project.toml for app source metadata #1231

Conversation

Haimantika commented Jul 15, 2021 • edited by jromero Loading

Summary

aemengo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jromero left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Import Groups

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Aug 2, 2021 • edited Loading

Codecov Report

Haimantika commented Jul 15, 2021 •

edited by jromero

Loading

jromero left a comment •

edited

Loading

codecov bot commented Aug 2, 2021 •

edited

Loading