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.

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

Bug 1910753: Use context directory to find devfile #7655

Merged
merged 1 commit into from Jan 12, 2021

Conversation

rottencandy
Copy link
Contributor

@rottencandy rottencandy commented Dec 24, 2020

Fixes:
https://issues.redhat.com/browse/ODC-5297

Analysis / Root cause:
When using the UI to select a directory path for the git, it fails to take this into account when we go searching for the Devfile.

Solution Description:
Use context directory and determine the correct path of the devfile.

NOTE: Depends on #7470, only consider ef9ca72

Screen shots / Gifs for design review:

Browser conformance:

  • Chrome
  • Firefox
  • Safari
  • Edge

@openshift-ci-robot openshift-ci-robot added component/dev-console Related to dev-console component/git-service Related to git-service labels Dec 24, 2020
@rottencandy rottencandy changed the title Devfilepath Use context directory to find devfile Dec 24, 2020
@rottencandy
Copy link
Contributor Author

/kind bug

@openshift-ci-robot openshift-ci-robot added the kind/bug Categorizes issue or PR as related to a bug. label Dec 24, 2020
@rottencandy rottencandy changed the title Use context directory to find devfile Bug 1910753: Use context directory to find devfile Dec 24, 2020
@openshift-ci-robot
Copy link
Contributor

@rottencandy: This pull request references Bugzilla bug 1910753, which is valid. The bug has been moved to the POST state. The bug has been updated to refer to the pull request using the external bug tracker.

3 validation(s) were run on this bug
  • bug is open, matching expected state (open)
  • bug target release (4.7.0) matches configured target release for branch (4.7.0)
  • bug is in the state NEW, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

In response to this:

Bug 1910753: Use context directory to find devfile

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-robot openshift-ci-robot added bugzilla/severity-medium Referenced Bugzilla bug's severity is medium for the branch this PR is targeting. bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. labels Dec 24, 2020
@openshift-ci-robot
Copy link
Contributor

@rottencandy: This pull request references Bugzilla bug 1910753, which is valid.

3 validation(s) were run on this bug
  • bug is open, matching expected state (open)
  • bug target release (4.7.0) matches configured target release for branch (4.7.0)
  • bug is in the state POST, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

In response to this:

Bug 1910753: Use context directory to find devfile

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-robot
Copy link
Contributor

@rottencandy: This pull request references Bugzilla bug 1910753, which is valid.

3 validation(s) were run on this bug
  • bug is open, matching expected state (open)
  • bug target release (4.7.0) matches configured target release for branch (4.7.0)
  • bug is in the state POST, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

In response to this:

Bug 1910753: Use context directory to find devfile

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.

@@ -105,7 +112,7 @@ export class GithubService extends BaseService {
const resp = await this.client.repos.getContents({
owner: this.metadata.owner,
repo: this.metadata.repoName,
path: 'Dockerfile',
path: `${this.metadata.contextDir}/Dockerfile`,
Copy link
Member

@jerolimov jerolimov Jan 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sure this works in almost all cases you tested. But because contextDir is defined as optional, I would like to request to check if contextDir is defined. So that we don't get an unexpected undefined/Dockerfile in some edge-cases. Similar you have done in gitlab-service.ts.

To archive this its maybe a good idea to create two helper functions isFilePresent(filename: string) and getFileContent(filename: string) which can do all these repeated work in this file where isDevfilePresent ends as a redirect to just

  isDevfilePresent = () => isFilePresent('devfile.yaml')
  getDevfileContent = () => getFileContent('devfile.yaml')

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The getRepoMetadata function will make sure that contextDir will always be available, at least as an empty string, so IMO checking for that isn't needed. What do you think?
There are even test cases where contextDir isn't provided.

Updated with helper functions isFilePresent & getFileContent.

@openshift-ci-robot
Copy link
Contributor

@rottencandy: This pull request references Bugzilla bug 1910753, which is valid.

3 validation(s) were run on this bug
  • bug is open, matching expected state (open)
  • bug target release (4.7.0) matches configured target release for branch (4.7.0)
  • bug is in the state POST, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

In response to this:

Bug 1910753: Use context directory to find devfile

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.

@rottencandy
Copy link
Contributor Author

cc: @rohitkrai03

Copy link
Contributor

@rohitkrai03 rohitkrai03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 12, 2021
@openshift-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rohitkrai03, rottencandy

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-robot openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 12, 2021
@openshift-merge-robot openshift-merge-robot merged commit f23cfaa into openshift:master Jan 12, 2021
@openshift-ci-robot
Copy link
Contributor

@rottencandy: All pull requests linked via external trackers have merged:

Bugzilla bug 1910753 has been moved to the MODIFIED state.

In response to this:

Bug 1910753: Use context directory to find devfile

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.

@spadgett spadgett added this to the v4.7 milestone Jan 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. bugzilla/severity-medium Referenced Bugzilla bug's severity is medium for the branch this PR is targeting. bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. component/dev-console Related to dev-console component/git-service Related to git-service kind/bug Categorizes issue or PR as related to a bug. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants