-
Notifications
You must be signed in to change notification settings - Fork 174
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: support progress output for attach, push and copy commands (#1138)
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
- Loading branch information
Showing
6 changed files
with
328 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| /* | ||
| Copyright The ORAS Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package track | ||
|
|
||
| import ( | ||
| "context" | ||
| "io" | ||
| "os" | ||
|
|
||
| ocispec "github.com/opencontainers/image-spec/specs-go/v1" | ||
| "oras.land/oras-go/v2" | ||
| "oras.land/oras-go/v2/registry" | ||
| "oras.land/oras/cmd/oras/internal/display/progress" | ||
| ) | ||
|
|
||
| // GraphTarget is a tracked oras.GraphTarget. | ||
| type GraphTarget interface { | ||
| oras.GraphTarget | ||
| io.Closer | ||
| Prompt(desc ocispec.Descriptor, prompt string, verbose bool) error | ||
| } | ||
|
|
||
| type graphTarget struct { | ||
| oras.GraphTarget | ||
| manager progress.Manager | ||
| actionPrompt string | ||
| donePrompt string | ||
| } | ||
|
|
||
| type referenceGraphTarget struct { | ||
| *graphTarget | ||
| } | ||
|
|
||
| // NewTarget creates a new tracked Target. | ||
| func NewTarget(t oras.GraphTarget, actionPrompt, donePrompt string, tty *os.File) (GraphTarget, error) { | ||
| manager, err := progress.NewManager(tty) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| gt := &graphTarget{ | ||
| GraphTarget: t, | ||
| manager: manager, | ||
| actionPrompt: actionPrompt, | ||
| donePrompt: donePrompt, | ||
| } | ||
|
|
||
| if _, ok := t.(registry.ReferencePusher); ok { | ||
| return &referenceGraphTarget{ | ||
| graphTarget: gt, | ||
| }, nil | ||
| } | ||
| return gt, nil | ||
| } | ||
|
|
||
| // Push pushes the content to the base oras.GraphTarget with tracking. | ||
| func (t *graphTarget) Push(ctx context.Context, expected ocispec.Descriptor, content io.Reader) error { | ||
| r, err := managedReader(content, expected, t.manager, t.actionPrompt, t.donePrompt) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer r.Close() | ||
| r.Start() | ||
| if err := t.GraphTarget.Push(ctx, expected, r); err != nil { | ||
| return err | ||
| } | ||
| r.Done() | ||
| return nil | ||
| } | ||
|
|
||
| // PushReference pushes the content to the base oras.GraphTarget with tracking. | ||
| func (rgt *referenceGraphTarget) PushReference(ctx context.Context, expected ocispec.Descriptor, content io.Reader, reference string) error { | ||
| r, err := managedReader(content, expected, rgt.manager, rgt.actionPrompt, rgt.donePrompt) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer r.Close() | ||
| r.Start() | ||
| err = rgt.GraphTarget.(registry.ReferencePusher).PushReference(ctx, expected, r, reference) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| r.Done() | ||
| return nil | ||
| } | ||
|
|
||
| // Close closes the tracking manager. | ||
| func (t *graphTarget) Close() error { | ||
| return t.manager.Close() | ||
| } | ||
|
|
||
| // Prompt prompts the user with the provided prompt and descriptor. | ||
| func (t *graphTarget) Prompt(desc ocispec.Descriptor, prompt string, verbose bool) error { | ||
| status, err := t.manager.Add() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer close(status) | ||
| status <- progress.NewStatus(prompt, desc, desc.Size) | ||
| status <- progress.EndTiming() | ||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.