Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add download starter project endpoints #109

Merged
merged 28 commits into from
Apr 12, 2022
Merged

Add download starter project endpoints #109

merged 28 commits into from
Apr 12, 2022

Conversation

michael-valdron
Copy link
Member

@michael-valdron michael-valdron commented Mar 22, 2022 •
edited
Loading

Signed-off-by: Michael Valdron [email protected]

Please specify the area for this PR
registry

What does does this PR do / why we need it:
Adds requested starter projects download endpoint to the registry server, after merging the handler in the registry viewer can use this endpoint to download starter projects from server side.

Which issue(s) this PR fixes:
Fixes devfile/api#720

PR acceptance criteria:

  • Test (WIP)

  • Documentation (WIP)

How to test changes / Special notes to the reviewer:
Accessing GET /devfiles/<devfileName>/starterProjects/<starterProjectName> such as /devfiles/java-maven/starterProjects/springbootproject should now prompt a download for a zip archive. GET /devfiles/<devfileName>/<version>/starterProjects/<starterProjectName> should also work as intended.

@michael-valdron
Squashed commit of the following:
03a9f60 
commit 40b70ab
Merge: 655c290 018c568
Author: Michael Valdron <[email protected]>
Date:   Tue Mar 1 15:31:08 2022 -0500

    fixed merge conflicts

commit 655c290
Merge: 3f4fb80 7a90a42
Author: Michael Valdron <[email protected]>
Date:   Thu Feb 24 21:24:37 2022 -0500

    Merge branch 'main' into addDownloadStarterProject

commit 3f4fb80
Author: Michael Valdron <[email protected]>
Date:   Thu Feb 17 18:13:18 2022 -0500

    starter project download git source changed to use index/generator functions.

commit 7170750
Author: Michael Valdron <[email protected]>
Date:   Thu Feb 17 18:12:14 2022 -0500

    dependency updates.

commit 9f72032
Author: Stephanie <[email protected]>
Date:   Tue Feb 15 16:21:24 2022 -0500

    add util.go for download from git

    Signed-off-by: Stephanie <[email protected]>

commit a86df62
Author: Michael Valdron <[email protected]>
Date:   Fri Feb 11 16:52:06 2022 -0500

    remove https from git url.

commit 40cde78
Author: Michael Valdron <[email protected]>
Date:   Fri Feb 11 15:01:28 2022 -0500

    Read archive bytes for zip urls fixed. Fixed ContentType set in response.

commit ce2090e
Author: Michael Valdron <[email protected]>
Date:   Fri Feb 11 14:01:31 2022 -0500

    golang image tag updated from alpine3.11 to alpine3.15

commit 1ce4615
Author: Michael Valdron <[email protected]>
Date:   Thu Feb 10 16:51:52 2022 -0500

    Removed commented out source of fetchDevfile impl 1 (unused).

commit 4edf10a
Author: Michael Valdron <[email protected]>
Date:   Thu Feb 10 16:50:37 2022 -0500

    source added for downloading starter project from zip url and git repository (root, remote -> origin)

commit ef946e8
Author: Michael Valdron <[email protected]>
Date:   Thu Feb 10 16:48:05 2022 -0500

    Dependency go-getter added for downloading starter projects using git as a source and with subDir set.

commit 8ca0364
Author: Michael Valdron <[email protected]>
Date:   Wed Feb 9 11:29:57 2022 -0500

    added missing return statements to error condition blocks.

commit 95c39f7
Merge: e8852e3 723fa9c
Author: Michael Valdron <[email protected]>
Date:   Wed Feb 9 11:20:49 2022 -0500

    Merge branch 'main' into addDownloadStarterProject

commit e8852e3
Author: Michael Valdron <[email protected]>
Date:   Tue Feb 8 19:50:42 2022 -0500

    param key change in index.go applied to serveStarterProjects endpoint. Control logic for starter project download methods added.

commit 768f0cb
Author: Michael Valdron <[email protected]>
Date:   Tue Feb 8 19:43:50 2022 -0500

    serveStarterProjects endpoint key :devfileName changed to :name to match serveDevfile endpoint pattern.

commit ff614c5
Author: Michael Valdron <[email protected]>
Date:   Mon Feb 7 18:03:34 2022 -0500

    dependency updates: go v1.14->v1.17, gin v1.6.3->v1.7.7, github.com/deislabs/oras v0.8.1->oras.land/oras-go v0.4.0

commit 9a5b40f
Merge: 0d01cd3 6566c05
Author: Michael Valdron <[email protected]>
Date:   Mon Feb 7 14:13:55 2022 -0500

    Merge branch 'addDownloadStarterProject' of github:michael-valdron/registry-support into addDownloadStarterProject

commit 0d01cd3
Author: Michael Valdron <[email protected]>
Date:   Fri Jan 28 17:29:35 2022 -0500

    fetchDevfile now returns the devfile's index schema for telemetry data.

commit 40db91a
Author: Michael Valdron <[email protected]>
Date:   Fri Jan 28 16:44:44 2022 -0500

    Implementation 2 for fetchDevfile chosen and added. See Issue #720 discussion at: devfile/api#720

commit 336153a
Author: Michael Valdron <[email protected]>
Date:   Tue Feb 1 16:52:43 2022 -0500

    filtering added using temp iteration and control logic, filter options commented out until new release of library.

commit f25e6b8
Author: Michael Valdron <[email protected]>
Date:   Tue Feb 1 11:25:03 2022 -0500

    library dependency added.

commit de05073
Author: Michael Valdron <[email protected]>
Date:   Mon Jan 31 20:58:45 2022 -0500

    get starter project entity source added.

commit c0a0f6e
Author: Michael Valdron <[email protected]>
Date:   Fri Jan 28 17:29:35 2022 -0500

    fetchDevfile now returns the devfile's index schema for telemetry data.

commit ac4f605
Author: Michael Valdron <[email protected]>
Date:   Fri Jan 28 16:44:44 2022 -0500

    Implementation 2 for fetchDevfile chosen and added. See Issue #720 discussion at: devfile/api#720

commit 8dd8c1c
Author: Michael Valdron <[email protected]>
Date:   Thu Jan 27 17:34:18 2022 -0500

    fixed up some return statements and flow control for fetching a devfile.

commit d5aba7a
Author: Michael Valdron <[email protected]>
Date:   Thu Jan 20 16:54:50 2022 -0500

    serveDevfileStarterProject endpoint definitions added.

commit 7b8e5ac
Author: Michael Valdron <[email protected]>
Date:   Wed Jan 26 19:21:38 2022 -0500

    draft proposal function source added.

commit 6b44b81
Author: Michael Valdron <[email protected]>
Date:   Wed Jan 26 19:20:21 2022 -0500

    endpoint URL format changes.

commit 0de93f6
Author: Michael Valdron <[email protected]>
Date:   Thu Jan 20 16:54:50 2022 -0500

    serveDevfileStarterProject endpoint definitions added.

commit 2dd0890
Author: Michael Valdron <[email protected]>
Date:   Thu Jan 20 16:46:08 2022 -0500

    reorganized util package import in index.go

commit 6566c05
Merge: 65dcb66 f96264a
Author: Michael Valdron <[email protected]>
Date:   Mon Feb 7 13:58:12 2022 -0500

    Merge branch 'addDownloadStarterProject' of github:michael-valdron/registry-support into addDownloadStarterProject

commit 65dcb66
Author: Michael Valdron <[email protected]>
Date:   Fri Jan 28 17:29:35 2022 -0500

    fetchDevfile now returns the devfile's index schema for telemetry data.

commit 9c10f03
Author: Michael Valdron <[email protected]>
Date:   Fri Jan 28 16:44:44 2022 -0500

    Implementation 2 for fetchDevfile chosen and added. See Issue #720 discussion at: devfile/api#720

commit f96264a
Merge: 3d7a869 e0351de
Author: Michael Valdron <[email protected]>
Date:   Mon Feb 7 13:51:24 2022 -0500

    Merge branch 'addDownloadStarterProject' of github:michael-valdron/registry-support into addDownloadStarterProject

commit 3d7a869
Author: Michael Valdron <[email protected]>
Date:   Tue Feb 1 16:52:43 2022 -0500

    filtering added using temp iteration and control logic, filter options commented out until new release of library.

commit 8cdd723
Author: Michael Valdron <[email protected]>
Date:   Tue Feb 1 11:25:03 2022 -0500

    library dependency added.

commit 476e7c6
Author: Michael Valdron <[email protected]>
Date:   Mon Jan 31 20:58:45 2022 -0500

    get starter project entity source added.

commit 9843452
Author: Michael Valdron <[email protected]>
Date:   Fri Jan 28 17:29:35 2022 -0500

    fetchDevfile now returns the devfile's index schema for telemetry data.

commit b6658b8
Author: Michael Valdron <[email protected]>
Date:   Fri Jan 28 16:44:44 2022 -0500

    Implementation 2 for fetchDevfile chosen and added. See Issue #720 discussion at: devfile/api#720

commit c0a9685
Author: Michael Valdron <[email protected]>
Date:   Thu Jan 27 17:34:18 2022 -0500

    fixed up some return statements and flow control for fetching a devfile.

commit 5da0574
Author: Michael Valdron <[email protected]>
Date:   Thu Jan 20 16:54:50 2022 -0500

    serveDevfileStarterProject endpoint definitions added.

commit e0351de
Author: Michael Valdron <[email protected]>
Date:   Tue Feb 1 16:52:43 2022 -0500

    filtering added using temp iteration and control logic, filter options commented out until new release of library.

commit 94e64ea
Author: Michael Valdron <[email protected]>
Date:   Tue Feb 1 11:25:03 2022 -0500

    library dependency added.

commit 99cbed9
Author: Michael Valdron <[email protected]>
Date:   Mon Jan 31 20:58:45 2022 -0500

    get starter project entity source added.

commit 2ca9308
Author: Michael Valdron <[email protected]>
Date:   Fri Jan 28 17:29:35 2022 -0500

    fetchDevfile now returns the devfile's index schema for telemetry data.

commit 2bb8eb9
Author: Michael Valdron <[email protected]>
Date:   Fri Jan 28 16:44:44 2022 -0500

    Implementation 2 for fetchDevfile chosen and added. See Issue #720 discussion at: devfile/api#720

commit 6ee2896
Author: Michael Valdron <[email protected]>
Date:   Thu Jan 27 17:34:18 2022 -0500

    fixed up some return statements and flow control for fetching a devfile.

commit b768325
Merge: 6bd6809 4e3a233
Author: Michael Valdron <[email protected]>
Date:   Wed Jan 26 19:23:38 2022 -0500

    fixed merge conflicts.

commit 6bd6809
Author: Michael Valdron <[email protected]>
Date:   Wed Jan 26 19:21:38 2022 -0500

    draft proposal function source added.

commit 0ed5d25
Author: Michael Valdron <[email protected]>
Date:   Wed Jan 26 19:20:21 2022 -0500

    endpoint URL format changes.

commit b119a18
Author: Michael Valdron <[email protected]>
Date:   Thu Jan 20 16:54:50 2022 -0500

    serveDevfileStarterProject endpoint definitions added.

commit 1bac181
Author: Michael Valdron <[email protected]>
Date:   Thu Jan 20 16:46:08 2022 -0500

    reorganized util package import in index.go

commit 4e3a233
Author: Michael Valdron <[email protected]>
Date:   Thu Jan 20 16:54:50 2022 -0500

    serveDevfileStarterProject endpoint definitions added.

commit a6f6343
Author: Michael Valdron <[email protected]>
Date:   Thu Jan 20 16:46:08 2022 -0500

    reorganized util package import in index.go

Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
update generator dependency to f06d84c along with other dependencies …
8c5da21 
…required by it.

Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
tidy dependencies.
ec54e07 
Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
serveDevfileStarterProject uses util functions from index/generator c…
15f231f 
…ommit f06d84c

Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
fetchDevfile changed to match process of current multi-version serveD…
9274b7a 
…evfileWithVersion endpoint. fetchDevfile signature changed to include version.

Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
devfileIndexSchema return on fetchDevfile invoke for serveDevfileStar…
3120278 
…terProject added to TODO

Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
multi version devfile source added to starter project endpoint. new v…
4d8f78e 
…ersion specifying endpoint for downloading starter projects added.

Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
serveDevfileWithVersion uses fetchDevfile function.
4bffa01 
Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
c.Data(http.StatusOK, http.DetectContentType(bytes), bytes) moved fro…
5bd8e11 
…m fetchDevfile to serveDevfileWithVersion as endpoint success response.

Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
generator conflicts fixed.
695eebd 
Signed-off-by: Michael Valdron <[email protected]>
@openshift-ci
Copy link

openshift-ci bot commented Mar 22, 2022

@michael-valdron: The label(s) area/registry cannot be applied, because the repository doesn't have them.

In response to this:

Please specify the area for this PR
/area registry

What does does this PR do / why we need it:

Which issue(s) this PR fixes:
Fixes devfile/api#720

PR acceptance criteria:

  • Test (WIP)

  • Documentation (WIP)

How to test changes / Special notes to the reviewer:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-ci openshift-ci bot requested review from elsony and johnmcollier March 22, 2022 19:15
michael-valdron and others added 14 commits March 23, 2022 13:55
@michael-valdron
backtrack dependency versions.
aa1a91b 
Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
backtrack dependencies further. back to go v1.14
84ec3fa 
Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
backtrack server Dockerfile to alpine3.11
94f9c97 
Signed-off-by: Michael Valdron <[email protected]>
@johnmcollier
Update registry dependencies
23e40ba 
Signed-off-by: John Collier <[email protected]>
@michael-valdron
gin-gonic/gin v1.6.3->v1.7.7 update restored.
95d286a 
Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
Merge branch 'fixdeps' of https://github.com/johnmcollier/registry-su…
0669707 
…pport into johnmcollier-fixdeps

Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
Merge branch 'johnmcollier-fixdeps' into sAddStarterProject
73743a0
@michael-valdron
integration testing for starter projects endpoint added.
cee3a7c 
Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
Read bytes before checking status code.
1889e25 
Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
integration tests for starter project endpoint now checks for status …
70d6723 
…code 202 instead of 200

Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
Empty byte array checks added for starter project endpoint int tests.
2022093 
Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
reading response in starter project integration tests changed.
882fb76 
Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
starter project endpoint downloads zip file with the name and ext.
608375f 
Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
Merge branch 'main' into sAddStarterProject
bcf0c87 
Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron michael-valdron marked this pull request as ready for review March 24, 2022 21:01
johnmcollier
johnmcollier requested changes Apr 7, 2022
View reviewed changes
index/server/pkg/server/endpoint.go Outdated Show resolved Hide resolved
index/server/pkg/server/endpoint.go Show resolved Hide resolved
index/server/pkg/server/endpoint.go Outdated Show resolved Hide resolved
index/server/pkg/server/endpoint.go Outdated Show resolved Hide resolved
index/server/pkg/server/endpoint.go Show resolved Hide resolved
@michael-valdron
serveRootEndpoint doc comment typo fixed.
2f2c8b0 
Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
'devfile of %s' corrected to '%s devfile' for response status message…
98a82b6 
… when named starter project does not exist within a given devfile.

Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
fetchDevfile doc comment improved to request of revision.
7384f33 
Signed-off-by: Michael Valdron <[email protected]>
@michael-valdron
starterProject.Git.CheckoutFrom.Remote only overwrites RemoteName if …
ba394fd 
…specified.

Signed-off-by: Michael Valdron <[email protected]>
@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Apr 12, 2022
@openshift-ci
Copy link

openshift-ci bot commented Apr 12, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: johnmcollier, michael-valdron

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 12, 2022
@michael-valdron michael-valdron merged commit 8acf9cb into devfile:main Apr 12, 2022
@michael-valdron michael-valdron deleted the sAddStarterProject branch July 13, 2022 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@johnmcollier johnmcollier johnmcollier approved these changes

@elsony elsony Awaiting requested review from elsony

@kim-tsao kim-tsao Awaiting requested review from kim-tsao

@schultzp2020 schultzp2020 Awaiting requested review from schultzp2020

Assignees

@johnmcollier johnmcollier

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create a download-starter-project endpoint in the registry.
2 participants
@michael-valdron @johnmcollier