Alignment with moby swagger definition for ContainerState.Status

[jiridanek]

Issue Description

According to moby definition, the permitted values for Status don't include the value "stopped",

https://github.com/moby/moby/blob/6f14c8ee5adc314a900808b0c991e12d9d28be67/api/swagger.yaml#L4624-L4630

but that's what I got in response from an inspect container request, and my app crashed on that

thread 'testcontainers::test_h2spec::test_h2spec' panicked at 'called `Result::unwrap()` on an `Err` value: 
JsonDataError { message: "unknown variant `stopped`,
 expected one of ``, `created`, `running`, `paused`, `restarting`, `removing`, `exited`, `dead` at line 1 column 192", column: 192 }', tests/testcontainers/test_h2spec.rs:359:119

Steps to reproduce the issue

let final_inspect = docker.inspect_container(&*container.id, Some(InspectContainerOptions { size: false })).await.unwrap();

Describe the results you received

"stopped"

Describe the results you expected

one of ``, created, `running`, `paused`, `restarting`, `removing`, `exited`, `dead`

podman info output

If you are unable to run podman info for any reason, please provide the podman version, operating system and its version and the architecture you are running.

host:
  arch: amd64
  buildahVersion: 1.29.0
  cgroupControllers:
  - cpu
  - io
  - memory
  - pids
  cgroupManager: systemd
  cgroupVersion: v2
  conmon:
    package: conmon-2.1.6-3.fc37.x86_64
    path: /usr/bin/conmon
    version: 'conmon version 2.1.6, commit: '
  cpuUtilization:
    idlePercent: 57.19
    systemPercent: 6.46
    userPercent: 36.35
  cpus: 12
  distribution:
    distribution: fedora
    variant: workstation
    version: "37"
  eventLogger: journald
  hostname: fedora.jiridanek.github.beta.tailscale.net
  idMappings:
    gidmap:
    - container_id: 0
      host_id: 1000
      size: 1
    - container_id: 1
      host_id: 100000
      size: 65536
    uidmap:
    - container_id: 0
      host_id: 1000
      size: 1
    - container_id: 1
      host_id: 100000
      size: 65536
  kernel: 6.1.14-200.fc37.x86_64
  linkmode: dynamic
  logDriver: journald
  memFree: 348434432
  memTotal: 33402236928
  networkBackend: netavark
  ociRuntime:
    name: crun
    package: crun-1.8.1-1.fc37.x86_64
    path: /usr/bin/crun
    version: |-
      crun version 1.8.1
      commit: f8a096be060b22ccd3d5f3ebe44108517fbf6c30
      rundir: /run/user/1000/crun
      spec: 1.0.0
      +SYSTEMD +SELINUX +APPARMOR +CAP +SECCOMP +EBPF +CRIU +LIBKRUN +WASM:wasmedge +YAJL
  os: linux
  remoteSocket:
    exists: true
    path: /run/user/1000/podman/podman.sock
  security:
    apparmorEnabled: false
    capabilities: CAP_CHOWN,CAP_DAC_OVERRIDE,CAP_FOWNER,CAP_FSETID,CAP_KILL,CAP_NET_BIND_SERVICE,CAP_SETFCAP,CAP_SETGID,CAP_SETPCAP,CAP_SETUID
    rootless: true
    seccompEnabled: true
    seccompProfilePath: /usr/share/containers/seccomp.json
    selinuxEnabled: false
  serviceIsRemote: false
  slirp4netns:
    executable: /usr/bin/slirp4netns
    package: slirp4netns-1.2.0-8.fc37.x86_64
    version: |-
      slirp4netns version 1.2.0
      commit: 656041d45cfca7a4176f6b7eed9e4fe6c11e8383
      libslirp: 4.7.0
      SLIRP_CONFIG_VERSION_MAX: 4
      libseccomp: 2.5.3
  swapFree: 262144
  swapTotal: 8589930496
  uptime: 175h 4m 55.00s (Approximately 7.29 days)
plugins:
  authorization: null
  log:
  - k8s-file
  - none
  - passthrough
  - journald
  network:
  - bridge
  - macvlan
  volume:
  - local
registries:
  search:
  - registry.fedoraproject.org
  - registry.access.redhat.com
  - docker.io
  - quay.io
store:
  configFile: /home/jdanek/.config/containers/storage.conf
  containerStore:
    number: 7
    paused: 0
    running: 0
    stopped: 7
  graphDriverName: overlay
  graphOptions: {}
  graphRoot: /home/jdanek/.local/share/containers/storage
  graphRootAllocated: 510389125120
  graphRootUsed: 474235437056
  graphStatus:
    Backing Filesystem: btrfs
    Native Overlay Diff: "true"
    Supports d_type: "true"
    Using metacopy: "false"
  imageCopyTmpDir: /var/tmp
  imageStore:
    number: 316
  runRoot: /run/user/1000/containers
  transientStore: false
  volumePath: /home/jdanek/.local/share/containers/storage/volumes
version:
  APIVersion: 4.4.2
  Built: 1677669779
  BuiltTime: Wed Mar  1 12:22:59 2023
  GitCommit: ""
  GoVersion: go1.19.6
  Os: linux
  OsArch: linux/amd64
  Version: 4.4.2

Podman in a container

No

Privileged Or Rootless

Rootless

Upstream Latest Release

No

Additional environment details

Additional environment details

Additional information

Additional information like issue happens only occasionally or issue happens with a particular architecture or on a particular setting

[jiridanek]

The states on podman side seem to be specified in

podman/libpod/define/containerstate.go

Lines 39 to 70 in 80be8c3

	// ContainerStatus returns a string representation for users of a container
	// state. All results should match Docker's versions (from `docker ps`) as
	// closely as possible, given the different set of states we support.
	func (t ContainerStatus) String() string {
	switch t {
	case ContainerStateUnknown:
	return "unknown"
	case ContainerStateConfigured:
	// The naming here is confusing, but it's necessary for Docker
	// compatibility - their Created state is our Configured state.
	return "created"
	case ContainerStateCreated:
	// Docker does not have an equivalent to this state, so give it
	// a clear name. Most of the time this is a purely transitory
	// state between Configured and Running so we don't expect to
	// see it much anyways.
	return "initialized"
	case ContainerStateRunning:
	return "running"
	case ContainerStateStopped:
	return "stopped"
	case ContainerStatePaused:
	return "paused"
	case ContainerStateExited:
	return "exited"
	case ContainerStateRemoving:
	return "removing"
	case ContainerStateStopping:
	return "stopping"
	}
	return "bad state"
	}

so, comparing that to the moby states from https://github.com/moby/moby/blob/6f14c8ee5adc314a900808b0c991e12d9d28be67/api/swagger.yaml#L4624-L4630

  ContainerState:
    description: |
      ContainerState stores container's running state. It's part of ContainerJSONBase
      and will be returned by the "inspect" command.
    type: "object"
    x-nullable: true
    properties:
      Status:
        description: |
          String representation of the container state. Can be one of "created",
          "running", "paused", "restarting", "removing", "exited", or "dead".
        type: "string"
        enum: ["created", "running", "paused", "restarting", "removing", "exited", "dead"]
        example: "running"

I see that podman has several extra states: initialized, stopped, stopping ,and unknown (assuming that can ever be produced).

[jiridanek]

I need to look to the compat api in podman, as explained in #14641 (comment)

So, when looking there, I see

podman/pkg/api/handlers/compat/containers.go

Lines 293 to 326 in 80be8c3

	// Some docker states are not the same as ours. This makes sure the state string stays true to the Docker API
	if state == define.ContainerStateCreated {
	stateStr = define.ContainerStateConfigured.String()
	}
	switch state {
	case define.ContainerStateConfigured, define.ContainerStateCreated:
	status = "Created"
	case define.ContainerStateStopped, define.ContainerStateExited:
	exitCode, _, err := l.ExitCode()
	if err != nil {
	return nil, err
	}
	finishedTime, err := l.FinishedTime()
	if err != nil {
	return nil, err
	}
	status = fmt.Sprintf("Exited (%d) %s ago", exitCode, units.HumanDuration(time.Since(finishedTime)))
	case define.ContainerStateRunning, define.ContainerStatePaused:
	startedTime, err := l.StartedTime()
	if err != nil {
	return nil, err
	}
	status = fmt.Sprintf("Up %s", units.HumanDuration(time.Since(startedTime)))
	if state == define.ContainerStatePaused {
	status += " (Paused)"
	}
	case define.ContainerStateRemoving:
	status = "Removal In Progress"
	case define.ContainerStateStopping:
	status = "Stopping"
	default:
	status = "Unknown"
	}

which says to me that if I were truly using the compat API, I should never see stopped, because it is filtered out in

podman/pkg/api/handlers/compat/containers.go

Lines 301 to 310 in 80be8c3

	case define.ContainerStateStopped, define.ContainerStateExited:
	exitCode, _, err := l.ExitCode()
	if err != nil {
	return nil, err
	}
	finishedTime, err := l.FinishedTime()
	if err != nil {
	return nil, err
	}
	status = fmt.Sprintf("Exited (%d) %s ago", exitCode, units.HumanDuration(time.Since(finishedTime)))

I thought that when I do

systemctl --user enable --now podman.socket
export DOCKER_HOST=unix:///run/user/${UID}/podman/podman.sock

and then use app that expects docker, it uses the compat podman api. Or am I wrong about this?

[mheon]

You should, indeed, be using the compat API if you're pointing an app written against the Docker API at our API socket.

I think that the API status filtering may only be happening for the /containers/json endpoint (podman/docker ps) instead of the /containers/$id/json endpoint (podman/docker inspect), which might explain why you're still seeing stopped.

[github-actions]

A friendly reminder that this issue had no activity for 30 days.

[jiridanek]