Skip to content

Provide Mock Interface for Devfile Downloads on devfile/library  #1221

Closed
devfile/library
#189
Closed
Provide Mock Interface for Devfile Downloads on devfile/library #1221
devfile/library
#189
Assignees
maysunfaisal
Labels
area/libraryCommon devfile library for interacting with devfileskind/user-storyUser story for new enhancement

Description

@kim-tsao
kim-tsao
opened on Aug 14, 2023

/kind user-story

Which area this user story is related to?

/area library

User Story

As a devfile library client, I want to mock test devfile downloads from a private repo so I can test my client code properly.

From the investigation that was done in #1216 (comment), we need to fix the DownloadInMemory function to:

  1. Error out when we receive an unsupported git vendor URL

  2. Convert the function to a method so tooling clients can write mock tests

  3. See what the impact is for the following scenarios:

    1. Setting the devfile content in context.Populate/PopulateURL - which would require mocking of these two methods as well
    2. Converting K8s URI to inline
    3. Reading the Kubernetes yaml for outerloop support, affecting our client usage.

Acceptance Criteria

  • Create/Update test cases and ensure they run on both happy path and error scenarios
  • If there's API breakage, ensure the old methods/functions are marked deprecated
  • Update documentation
  • ....
  • ....

Activity

  1. openshift-ci
    added
    kind/user-storyUser story for new enhancement
    area/libraryCommon devfile library for interacting with devfiles
    on Aug 14, 2023
  2. kim-tsao
    self-assigned this
    on Aug 14, 2023
  3. github-project-automation
    added this to Devfile Projecton Aug 14, 2023
  4. kim-tsao
    added this to Devfile Project and removed this from Devfile Projecton Aug 14, 2023
  5. thepetk
    moved this to To Do 📝 in Devfile Projecton Aug 21, 2023
  6. rm3l
    unassigned
    kim-tsao
    on Sep 18, 2023
  7. rm3l
    moved this from To Do 📝 to Backlog in Devfile Projecton Sep 18, 2023

  8. github-actions commented on Nov 13, 2023

    @github-actions
    github-actionsbot
    on Nov 13, 2023 – with GitHub Actions

    This issue is stale because it has been open for 90 days with no activity. Remove stale label or comment or this will be closed in 60 days.

  9. github-actions
    added
    lifecycle/staleStale items. These items have not been updated for 90 days.
    on Nov 13, 2023
  10. maysunfaisal
    removed
    lifecycle/staleStale items. These items have not been updated for 90 days.
    on Nov 14, 2023
  11. maysunfaisal
    self-assigned this
    on Nov 16, 2023
  12. maysunfaisal
    moved this from Backlog to In Progress 🚧 in Devfile Projecton Nov 16, 2023

  13. maysunfaisal commented on Nov 20, 2023

    @maysunfaisal
    maysunfaisal
    on Nov 20, 2023
    Member

    Error out when we receive an unsupported git vendor URL

    Thought about this, but we should not error out in these situations and treat such git vendors as regular URLs and attempt a best case regular GET like other URLs

  14. maysunfaisal
    moved this from In Progress 🚧 to In Review 👀 in Devfile Projecton Nov 20, 2023
  15. maysunfaisal
    closed this as completedin library#189on Nov 27, 2023
  16. github-project-automation
    moved this from In Review 👀 to Done ✅ in Devfile Projecton Nov 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

area/libraryCommon devfile library for interacting with devfileskind/user-storyUser story for new enhancement

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions