Bugfix for pinned volumes in system reset

* Renames the global variable 'includePinned' to 'resetIncludePinned'
to improve code clarity and prevent potential variable shadowing.

* Adds SystemResetOptions type alias to the entities package.

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

Author: tobwen

cmd/podman/common/completion.go

@@ -1933,6 +1933,7 @@ func AutocompleteVolumeFilters(cmd *cobra.Command, _ []string, toComplete string
 		"label=":    nil,
 		"name=":     func(s string) ([]string, cobra.ShellCompDirective) { return getVolumes(cmd, s) },
 		"opt=":      nil,
+		"pinned=":   getBoolCompletion,
 		"scope=":    local,
 		"since=":    getImg,
 		"until=":    nil,

cmd/podman/system/prune.go

@@ -93,11 +93,6 @@ func prune(_ *cobra.Command, _ []string) error {
 	if err != nil {
 		return err
 	}
-	
-	// Set the include pinned flag for volume pruning
-	if pruneOptions.Volume {
-		pruneOptions.VolumePruneOptions.IncludePinned = includePinned
-	}
 
 	response, err := registry.ContainerEngine().SystemPrune(context.Background(), pruneOptions)
 	if err != nil {

cmd/podman/system/reset.go

@@ -33,8 +33,8 @@ var (
 		ValidArgsFunction: completion.AutocompleteNone,
 	}
 
-	forceFlag     bool
-	includePinned bool
+	forceFlag          bool
+	resetIncludePinned bool
 )
 
 func init() {
@@ -44,7 +44,7 @@ func init() {
 	})
 	flags := systemResetCommand.Flags()
 	flags.BoolVarP(&forceFlag, "force", "f", false, "Do not prompt for confirmation")
-	flags.BoolVar(&includePinned, "include-pinned", false, "Include pinned volumes in reset operation")
+	flags.BoolVar(&resetIncludePinned, "include-pinned", false, "Include pinned volumes in reset operation")
 }
 
 func reset(_ *cobra.Command, _ []string) {
@@ -57,7 +57,7 @@ func reset(_ *cobra.Command, _ []string) {
 	if !forceFlag {
 		reader := bufio.NewReader(os.Stdin)
 		volumeMsg := "        - all volumes (excluding pinned volumes)"
-		if includePinned {
+		if resetIncludePinned {
 			volumeMsg = "        - all volumes"
 		}
 		fmt.Printf(`WARNING! This will remove:
@@ -102,7 +102,7 @@ func reset(_ *cobra.Command, _ []string) {
 
 	// ContainerEngine() is unusable and shut down after this.
 	resetOptions := entities.SystemResetOptions{
-		IncludePinned: includePinned,
+		IncludePinned: resetIncludePinned,
 	}
 	if err := registry.ContainerEngine().Reset(registry.Context(), resetOptions); err != nil {
 		logrus.Error(err)

cmd/podman/volumes/prune.go

@@ -30,7 +30,8 @@ var (
 		RunE:              prune,
 		ValidArgsFunction: completion.AutocompleteNone,
 	}
-	filter = []string{}
+	filter       = []string{}
+	pruneOptions = entities.VolumePruneOptions{}
 )
 
 func init() {
@@ -44,6 +45,7 @@ func init() {
 	flags.StringArrayVar(&filter, filterFlagName, []string{}, "Provide filter values (e.g. 'label=<key>=<value>')")
 	_ = pruneCommand.RegisterFlagCompletionFunc(filterFlagName, common.AutocompleteVolumeFilters)
 	flags.BoolP("force", "f", false, "Do not prompt for confirmation")
+	flags.BoolVar(&pruneOptions.IncludePinned, "include-pinned", false, "Do not prune pinned volumes")
 }
 
 func prune(cmd *cobra.Command, _ []string) error {

docs/source/markdown/podman-volume-inspect.1.md

@@ -44,8 +44,8 @@ Valid placeholders for the Go template are listed below:
 | .Status ...         | Status of the volume                                                        |
 | .StorageID          | StorageID of the volume                                                     |
 | .Timeout            | Timeout of the volume                                                       |
-| .UID                | UID the volume was created with                                             |
 | .Pinned             | Whether the volume is pinned                                                |
+| .UID                | UID the volume was created with                                             |
 
 #### **--help**
 

docs/source/markdown/podman-volume-ls.1.md.in

@@ -60,8 +60,8 @@ Valid placeholders for the Go template are listed below:
 | .Status ...               | Status of the volume                         |
 | .StorageID                | StorageID of the volume                      |
 | .Timeout                  | Timeout of the volume                        |
-| .UID                      | UID of volume                                |
 | .Pinned                   | Whether the volume is pinned                 |
+| .UID                      | UID of volume                                |
 | .VolumeConfigResponse ... | Don't use                                    |
 
 #### **--help**

docs/source/markdown/podman-volume-pin.1.md

@@ -16,14 +16,14 @@ By default, **podman volume pin** marks volumes as pinned. Use the **--unpin** o
 
 ## OPTIONS
 
-#### **--unpin**
-
-Remove the pinned status from the specified volumes instead of pinning them.
-
 #### **--help**
 
 Print usage statement.
 
+#### **--unpin**
+
+Remove the pinned status from the specified volumes instead of pinning them.
+
 ## EXAMPLES
 
 Mark a volume as pinned.

pkg/domain/entities/system.go

@@ -10,6 +10,7 @@ type (
 	SystemPruneOptions      = types.SystemPruneOptions
 	SystemPruneReport       = types.SystemPruneReport
 	SystemMigrateOptions    = types.SystemMigrateOptions
+	SystemResetOptions      = types.SystemResetOptions
 	SystemCheckOptions      = types.SystemCheckOptions
 	SystemCheckReport       = types.SystemCheckReport
 	SystemDfOptions         = types.SystemDfOptions

pkg/domain/infra/abi/volumes.go

@@ -283,7 +283,7 @@ func (ic *ContainerEngine) VolumeExport(_ context.Context, nameOrID string, opti
 }
 
 func (ic *ContainerEngine) VolumePin(ctx context.Context, namesOrIds []string, opts entities.VolumePinOptions) ([]*entities.VolumePinReport, error) {
-	var reports []*entities.VolumePinReport
+	reports := make([]*entities.VolumePinReport, 0, len(namesOrIds))
 
 	for _, nameOrId := range namesOrIds {
 		report := &entities.VolumePinReport{Id: nameOrId}

pkg/domain/infra/tunnel/volumes.go

@@ -122,7 +122,7 @@ func (ic *ContainerEngine) VolumeImport(_ context.Context, nameOrID string, opti
 	return volumes.Import(ic.ClientCtx, nameOrID, options.Input)
 }
 
-func (ic *ContainerEngine) VolumePin(ctx context.Context, namesOrIds []string, opts entities.VolumePinOptions) ([]*entities.VolumePinReport, error) {
+func (ic *ContainerEngine) VolumePin(_ context.Context, namesOrIds []string, _ entities.VolumePinOptions) ([]*entities.VolumePinReport, error) {
 	reports := make([]*entities.VolumePinReport, 0, len(namesOrIds))
 	for _, nameOrId := range namesOrIds {
 		report := &entities.VolumePinReport{