mirror of https://github.com/k3s-io/k3s
Merge pull request #36764 from ymqytw/make_edit_before_create_iterate
Automatic merge from submit-queue make kubectl create --edit iterate `kubectl create --edit` is broken after #36148 merged. `kubectl create --edit` will fail when a manifest that contains multiple resources. I guess the root cause is that dynamic typer doesn't support a list of resources currently. This PR makes `kubectl create --edit` iterate again as `kubectl create`.pull/6/head
Kubernetes Submit Queue
GitHub
commit
424286996a
|
|
@ -728,21 +728,34 @@ runTests() {
|
||||||
kubectl delete -f hack/testdata/pod.yaml "${kube_flags[@]}"
|
kubectl delete -f hack/testdata/pod.yaml "${kube_flags[@]}"
|
||||||
|
|
||||||
### Create valid-pod POD
|
### Create valid-pod POD
|
||||||
# Pre-condition: no POD exists
|
# Pre-condition: no services and no rcs exist
|
||||||
create_and_use_new_namespace
|
kube::test::get_object_assert service "{{range.items}}{{$id_field}}:{{end}}" ''
|
||||||
kube::test::get_object_assert pods "{{range.items}}{{$id_field}}:{{end}}" ''
|
kube::test::get_object_assert rc "{{range.items}}{{$id_field}}:{{end}}" ''
|
||||||
## kubectl create --edit can update the image field of a POD. tmp-editor.sh is a fake editor
|
## kubectl create --edit can update the label filed of multiple resources. tmp-editor.sh is a fake editor
|
||||||
TEMP=$(mktemp /tmp/tmp-editor-XXXXXXXX.sh)
|
TEMP=$(mktemp /tmp/tmp-editor-XXXXXXXX.sh)
|
||||||
echo -e "#!/bin/bash\n$SED -i \"s/gcr.io\/google_containers\/serve_hostname/nginx/g\" \$1" > ${TEMP}
|
echo -e "#!/bin/bash\n$SED -i \"s/mock/modified/g\" \$1" > ${TEMP}
|
||||||
chmod +x ${TEMP}
|
chmod +x ${TEMP}
|
||||||
# Command
|
# Command
|
||||||
EDITOR=${TEMP} kubectl create --edit -f test/fixtures/doc-yaml/admin/limitrange/valid-pod.yaml "${kube_flags[@]}"
|
EDITOR=${TEMP} kubectl create --edit -f hack/testdata/multi-resource-json.json "${kube_flags[@]}"
|
||||||
# Post-condition: valid-pod POD is created and has image gcr.io/google_containers/serve_hostname
|
# Post-condition: service named modified and rc named modified are created
|
||||||
kube::test::get_object_assert pods "{{range.items}}{{$id_field}}:{{end}}" 'valid-pod:'
|
kube::test::get_object_assert service "{{range.items}}{{$id_field}}:{{end}}" 'modified:'
|
||||||
kube::test::get_object_assert pods "{{range.items}}{{$image_field}}:{{end}}" 'nginx:'
|
kube::test::get_object_assert rc "{{range.items}}{{$id_field}}:{{end}}" 'modified:'
|
||||||
|
# Clean up
|
||||||
|
kubectl delete service/modified "${kube_flags[@]}"
|
||||||
|
kubectl delete rc/modified "${kube_flags[@]}"
|
||||||
|
|
||||||
|
# Pre-condition: no services and no rcs exist
|
||||||
|
kube::test::get_object_assert service "{{range.items}}{{$id_field}}:{{end}}" ''
|
||||||
|
kube::test::get_object_assert rc "{{range.items}}{{$id_field}}:{{end}}" ''
|
||||||
|
# Command
|
||||||
|
EDITOR=${TEMP} kubectl create --edit -f hack/testdata/multi-resource-list.json "${kube_flags[@]}"
|
||||||
|
# Post-condition: service named modified and rc named modified are created
|
||||||
|
kube::test::get_object_assert service "{{range.items}}{{$id_field}}:{{end}}" 'modified:'
|
||||||
|
kube::test::get_object_assert rc "{{range.items}}{{$id_field}}:{{end}}" 'modified:'
|
||||||
# Clean up
|
# Clean up
|
||||||
rm ${TEMP}
|
rm ${TEMP}
|
||||||
kubectl delete pods/valid-pod "${kube_flags[@]}"
|
kubectl delete service/modified "${kube_flags[@]}"
|
||||||
|
kubectl delete rc/modified "${kube_flags[@]}"
|
||||||
|
|
||||||
## kubectl create --edit won't create anything if user makes no changes
|
## kubectl create --edit won't create anything if user makes no changes
|
||||||
[ "$(EDITOR=cat kubectl create --edit -f test/fixtures/doc-yaml/admin/limitrange/valid-pod.yaml -o json 2>&1 | grep 'Edit cancelled')" ]
|
[ "$(EDITOR=cat kubectl create --edit -f test/fixtures/doc-yaml/admin/limitrange/valid-pod.yaml -o json 2>&1 | grep 'Edit cancelled')" ]
|
||||||
|
|
|
||||||
|
|
@ -143,7 +143,7 @@ func runEdit(f cmdutil.Factory, out, errOut io.Writer, cmd *cobra.Command, args
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
infos, err := r.Infos()
|
normalEditInfos, err := r.Infos()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
@ -153,171 +153,193 @@ func runEdit(f cmdutil.Factory, out, errOut io.Writer, cmd *cobra.Command, args
|
||||||
edit = editor.NewDefaultEditor(f.EditorEnvs())
|
edit = editor.NewDefaultEditor(f.EditorEnvs())
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
editFn := func(info *resource.Info, err error) error {
|
||||||
results = editResults{}
|
var (
|
||||||
original = []byte{}
|
results = editResults{}
|
||||||
edited = []byte{}
|
original = []byte{}
|
||||||
file string
|
edited = []byte{}
|
||||||
)
|
file string
|
||||||
|
)
|
||||||
|
|
||||||
containsError := false
|
containsError := false
|
||||||
for {
|
var infos []*resource.Info
|
||||||
originalObj, err := resource.AsVersionedObject(infos, false, defaultVersion, encoder)
|
for {
|
||||||
if err != nil {
|
switch editMode {
|
||||||
return err
|
case NormalEditMode:
|
||||||
}
|
infos = normalEditInfos
|
||||||
|
case EditBeforeCreateMode:
|
||||||
|
infos = []*resource.Info{info}
|
||||||
|
default:
|
||||||
|
err = fmt.Errorf("Not supported edit mode %q", editMode)
|
||||||
|
}
|
||||||
|
originalObj, err := resource.AsVersionedObject(infos, false, defaultVersion, encoder)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
objToEdit := originalObj
|
objToEdit := originalObj
|
||||||
|
|
||||||
// generate the file to edit
|
// generate the file to edit
|
||||||
buf := &bytes.Buffer{}
|
buf := &bytes.Buffer{}
|
||||||
var w io.Writer = buf
|
var w io.Writer = buf
|
||||||
if windowsLineEndings {
|
if windowsLineEndings {
|
||||||
w = crlf.NewCRLFWriter(w)
|
w = crlf.NewCRLFWriter(w)
|
||||||
}
|
}
|
||||||
|
|
||||||
if o.addHeader {
|
if o.addHeader {
|
||||||
results.header.writeTo(w)
|
results.header.writeTo(w)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !containsError {
|
if !containsError {
|
||||||
if err := o.printer.PrintObj(objToEdit, w); err != nil {
|
if err := o.printer.PrintObj(objToEdit, w); err != nil {
|
||||||
|
return preservedFile(err, results.file, errOut)
|
||||||
|
}
|
||||||
|
original = buf.Bytes()
|
||||||
|
} else {
|
||||||
|
// In case of an error, preserve the edited file.
|
||||||
|
// Remove the comments (header) from it since we already
|
||||||
|
// have included the latest header in the buffer above.
|
||||||
|
buf.Write(manualStrip(edited))
|
||||||
|
}
|
||||||
|
|
||||||
|
// launch the editor
|
||||||
|
editedDiff := edited
|
||||||
|
edited, file, err = edit.LaunchTempFile(fmt.Sprintf("%s-edit-", filepath.Base(os.Args[0])), o.ext, buf)
|
||||||
|
if err != nil {
|
||||||
return preservedFile(err, results.file, errOut)
|
return preservedFile(err, results.file, errOut)
|
||||||
}
|
}
|
||||||
original = buf.Bytes()
|
if editMode == NormalEditMode || containsError {
|
||||||
} else {
|
if bytes.Equal(stripComments(editedDiff), stripComments(edited)) {
|
||||||
// In case of an error, preserve the edited file.
|
// Ugly hack right here. We will hit this either (1) when we try to
|
||||||
// Remove the comments (header) from it since we already
|
// save the same changes we tried to save in the previous iteration
|
||||||
// have included the latest header in the buffer above.
|
// which means our changes are invalid or (2) when we exit the second
|
||||||
buf.Write(manualStrip(edited))
|
// time. The second case is more usual so we can probably live with it.
|
||||||
}
|
// TODO: A less hacky fix would be welcome :)
|
||||||
|
return preservedFile(fmt.Errorf("%s", "Edit cancelled, no valid changes were saved."), file, errOut)
|
||||||
// launch the editor
|
}
|
||||||
editedDiff := edited
|
|
||||||
edited, file, err = edit.LaunchTempFile(fmt.Sprintf("%s-edit-", filepath.Base(os.Args[0])), o.ext, buf)
|
|
||||||
if err != nil {
|
|
||||||
return preservedFile(err, results.file, errOut)
|
|
||||||
}
|
|
||||||
if editMode == NormalEditMode || containsError {
|
|
||||||
if bytes.Equal(stripComments(editedDiff), stripComments(edited)) {
|
|
||||||
// Ugly hack right here. We will hit this either (1) when we try to
|
|
||||||
// save the same changes we tried to save in the previous iteration
|
|
||||||
// which means our changes are invalid or (2) when we exit the second
|
|
||||||
// time. The second case is more usual so we can probably live with it.
|
|
||||||
// TODO: A less hacky fix would be welcome :)
|
|
||||||
return preservedFile(fmt.Errorf("%s", "Edit cancelled, no valid changes were saved."), file, errOut)
|
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
// cleanup any file from the previous pass
|
// cleanup any file from the previous pass
|
||||||
if len(results.file) > 0 {
|
if len(results.file) > 0 {
|
||||||
os.Remove(results.file)
|
os.Remove(results.file)
|
||||||
}
|
}
|
||||||
glog.V(4).Infof("User edited:\n%s", string(edited))
|
glog.V(4).Infof("User edited:\n%s", string(edited))
|
||||||
|
|
||||||
|
// Apply validation
|
||||||
|
schema, err := f.Validator(cmdutil.GetFlagBool(cmd, "validate"), cmdutil.GetFlagString(cmd, "schema-cache-dir"))
|
||||||
|
if err != nil {
|
||||||
|
return preservedFile(err, file, errOut)
|
||||||
|
}
|
||||||
|
err = schema.ValidateBytes(stripComments(edited))
|
||||||
|
if err != nil {
|
||||||
|
results = editResults{
|
||||||
|
file: file,
|
||||||
|
}
|
||||||
|
containsError = true
|
||||||
|
fmt.Fprintln(out, results.addError(errors.NewInvalid(api.Kind(""), "", field.ErrorList{field.Invalid(nil, "The edited file failed validation", fmt.Sprintf("%v", err))}), infos[0]))
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Compare content without comments
|
||||||
|
if bytes.Equal(stripComments(original), stripComments(edited)) {
|
||||||
|
os.Remove(file)
|
||||||
|
fmt.Fprintln(errOut, "Edit cancelled, no changes made.")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
lines, err := hasLines(bytes.NewBuffer(edited))
|
||||||
|
if err != nil {
|
||||||
|
return preservedFile(err, file, errOut)
|
||||||
|
}
|
||||||
|
if !lines {
|
||||||
|
os.Remove(file)
|
||||||
|
fmt.Fprintln(errOut, "Edit cancelled, saved file was empty.")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// Apply validation
|
|
||||||
schema, err := f.Validator(cmdutil.GetFlagBool(cmd, "validate"), cmdutil.GetFlagString(cmd, "schema-cache-dir"))
|
|
||||||
if err != nil {
|
|
||||||
return preservedFile(err, file, errOut)
|
|
||||||
}
|
|
||||||
err = schema.ValidateBytes(stripComments(edited))
|
|
||||||
if err != nil {
|
|
||||||
results = editResults{
|
results = editResults{
|
||||||
file: file,
|
file: file,
|
||||||
}
|
}
|
||||||
containsError = true
|
|
||||||
fmt.Fprintln(out, results.addError(errors.NewInvalid(api.Kind(""), "", field.ErrorList{field.Invalid(nil, "The edited file failed validation", fmt.Sprintf("%v", err))}), infos[0]))
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// Compare content without comments
|
// parse the edited file
|
||||||
if bytes.Equal(stripComments(original), stripComments(edited)) {
|
updates, err := resourceMapper.InfoForData(edited, "edited-file")
|
||||||
os.Remove(file)
|
if err != nil {
|
||||||
fmt.Fprintln(errOut, "Edit cancelled, no changes made.")
|
// syntax error
|
||||||
return nil
|
containsError = true
|
||||||
}
|
results.header.reasons = append(results.header.reasons, editReason{head: fmt.Sprintf("The edited file had a syntax error: %v", err)})
|
||||||
|
continue
|
||||||
lines, err := hasLines(bytes.NewBuffer(edited))
|
|
||||||
if err != nil {
|
|
||||||
return preservedFile(err, file, errOut)
|
|
||||||
}
|
|
||||||
if !lines {
|
|
||||||
os.Remove(file)
|
|
||||||
fmt.Fprintln(errOut, "Edit cancelled, saved file was empty.")
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
results = editResults{
|
|
||||||
file: file,
|
|
||||||
}
|
|
||||||
|
|
||||||
// parse the edited file
|
|
||||||
updates, err := resourceMapper.InfoForData(edited, "edited-file")
|
|
||||||
if err != nil {
|
|
||||||
// syntax error
|
|
||||||
containsError = true
|
|
||||||
results.header.reasons = append(results.header.reasons, editReason{head: fmt.Sprintf("The edited file had a syntax error: %v", err)})
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
// not a syntax error as it turns out...
|
|
||||||
containsError = false
|
|
||||||
|
|
||||||
namespaceVisitor := resource.NewFlattenListVisitor(updates, resourceMapper)
|
|
||||||
// need to make sure the original namespace wasn't changed while editing
|
|
||||||
if err = namespaceVisitor.Visit(resource.RequireNamespace(cmdNamespace)); err != nil {
|
|
||||||
return preservedFile(err, file, errOut)
|
|
||||||
}
|
|
||||||
|
|
||||||
// iterate through all items to apply annotations
|
|
||||||
mutatedObjects, err := visitAnnotation(cmd, f, updates, resourceMapper, encoder)
|
|
||||||
if err != nil {
|
|
||||||
return preservedFile(err, file, errOut)
|
|
||||||
}
|
|
||||||
|
|
||||||
// if we mutated a list in the visitor, persist the changes on the overall object
|
|
||||||
if meta.IsListType(updates.Object) {
|
|
||||||
meta.SetList(updates.Object, mutatedObjects)
|
|
||||||
}
|
|
||||||
|
|
||||||
switch editMode {
|
|
||||||
case NormalEditMode:
|
|
||||||
err = visitToPatch(originalObj, updates, f, mapper, resourceMapper, encoder, out, errOut, defaultVersion, &results, file)
|
|
||||||
case EditBeforeCreateMode:
|
|
||||||
err = visitToCreate(updates, mapper, resourceMapper, out, errOut, defaultVersion, &results, file)
|
|
||||||
default:
|
|
||||||
err = fmt.Errorf("Not supported edit mode %q", editMode)
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
return preservedFile(err, results.file, errOut)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Handle all possible errors
|
|
||||||
//
|
|
||||||
// 1. retryable: propose kubectl replace -f
|
|
||||||
// 2. notfound: indicate the location of the saved configuration of the deleted resource
|
|
||||||
// 3. invalid: retry those on the spot by looping ie. reloading the editor
|
|
||||||
if results.retryable > 0 {
|
|
||||||
fmt.Fprintf(errOut, "You can run `%s replace -f %s` to try this update again.\n", filepath.Base(os.Args[0]), file)
|
|
||||||
return cmdutil.ErrExit
|
|
||||||
}
|
|
||||||
if results.notfound > 0 {
|
|
||||||
fmt.Fprintf(errOut, "The edits you made on deleted resources have been saved to %q\n", file)
|
|
||||||
return cmdutil.ErrExit
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(results.edit) == 0 {
|
|
||||||
if results.notfound == 0 {
|
|
||||||
os.Remove(file)
|
|
||||||
} else {
|
|
||||||
fmt.Fprintf(out, "The edits you made on deleted resources have been saved to %q\n", file)
|
|
||||||
}
|
}
|
||||||
return nil
|
// not a syntax error as it turns out...
|
||||||
}
|
containsError = false
|
||||||
|
|
||||||
if len(results.header.reasons) > 0 {
|
namespaceVisitor := resource.NewFlattenListVisitor(updates, resourceMapper)
|
||||||
containsError = true
|
// need to make sure the original namespace wasn't changed while editing
|
||||||
|
if err = namespaceVisitor.Visit(resource.RequireNamespace(cmdNamespace)); err != nil {
|
||||||
|
return preservedFile(err, file, errOut)
|
||||||
|
}
|
||||||
|
|
||||||
|
// iterate through all items to apply annotations
|
||||||
|
mutatedObjects, err := visitAnnotation(cmd, f, updates, resourceMapper, encoder)
|
||||||
|
if err != nil {
|
||||||
|
return preservedFile(err, file, errOut)
|
||||||
|
}
|
||||||
|
|
||||||
|
// if we mutated a list in the visitor, persist the changes on the overall object
|
||||||
|
if meta.IsListType(updates.Object) {
|
||||||
|
meta.SetList(updates.Object, mutatedObjects)
|
||||||
|
}
|
||||||
|
|
||||||
|
switch editMode {
|
||||||
|
case NormalEditMode:
|
||||||
|
err = visitToPatch(originalObj, updates, f, mapper, resourceMapper, encoder, out, errOut, defaultVersion, &results, file)
|
||||||
|
case EditBeforeCreateMode:
|
||||||
|
err = visitToCreate(updates, mapper, resourceMapper, out, errOut, defaultVersion, &results, file)
|
||||||
|
default:
|
||||||
|
err = fmt.Errorf("Not supported edit mode %q", editMode)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return preservedFile(err, results.file, errOut)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handle all possible errors
|
||||||
|
//
|
||||||
|
// 1. retryable: propose kubectl replace -f
|
||||||
|
// 2. notfound: indicate the location of the saved configuration of the deleted resource
|
||||||
|
// 3. invalid: retry those on the spot by looping ie. reloading the editor
|
||||||
|
if results.retryable > 0 {
|
||||||
|
fmt.Fprintf(errOut, "You can run `%s replace -f %s` to try this update again.\n", filepath.Base(os.Args[0]), file)
|
||||||
|
return cmdutil.ErrExit
|
||||||
|
}
|
||||||
|
if results.notfound > 0 {
|
||||||
|
fmt.Fprintf(errOut, "The edits you made on deleted resources have been saved to %q\n", file)
|
||||||
|
return cmdutil.ErrExit
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(results.edit) == 0 {
|
||||||
|
if results.notfound == 0 {
|
||||||
|
os.Remove(file)
|
||||||
|
} else {
|
||||||
|
fmt.Fprintf(out, "The edits you made on deleted resources have been saved to %q\n", file)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(results.header.reasons) > 0 {
|
||||||
|
containsError = true
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
switch editMode {
|
||||||
|
// If doing normal edit we cannot use Visit because we need to edit a list for convenience. Ref: #20519
|
||||||
|
case NormalEditMode:
|
||||||
|
return editFn(nil, nil)
|
||||||
|
// If doing an edit before created, we don't want a list and instead want the normal behavior as kubectl create.
|
||||||
|
case EditBeforeCreateMode:
|
||||||
|
return r.Visit(editFn)
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("Not supported edit mode %q", editMode)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func getPrinter(cmd *cobra.Command) (*editPrinterOptions, error) {
|
func getPrinter(cmd *cobra.Command) (*editPrinterOptions, error) {
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue