2022-08-02 21:25:59 +02:00
|
|
|
/*
|
|
|
|
Copyright 2022 Docker Compose CLI 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 e2e
|
|
|
|
|
|
|
|
import (
|
|
|
|
"encoding/json"
|
|
|
|
"strings"
|
|
|
|
"testing"
|
|
|
|
|
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
)
|
|
|
|
|
|
|
|
// RequireServiceState ensures that the container is in the expected state
|
|
|
|
// (running or exited).
|
|
|
|
func RequireServiceState(t testing.TB, cli *CLI, service string, state string) {
|
|
|
|
t.Helper()
|
up: fix various race/deadlock conditions on exit (#10934)
If running `up` in foreground mode (i.e. not `-d`),
when exiting via `Ctrl-C`, Compose stops all the
services it launched directly as part of that `up`
command.
In one of the E2E tests (`TestUpDependenciesNotStopped`),
this was occasionally flaking because the stop
behavior was racy: the return might not block on
the stop operation because it gets added to the
error group in a goroutine. As a result, it was
possible for no services to get terminated on exit.
There were a few other related pieces here that
I uncovered and tried to fix while stressing this.
For example, the printer could cause a deadlock if
an event was sent to it after it stopped.
Also, an error group wasn't really appropriate here;
each goroutine is a different operation for printing,
signal-handling, etc. If one part fails, we don't
actually want printing to stop, for example. This has
been switched to a `multierror.Group`, which has the
same API but coalesces errors instead of canceling a
context the moment the first one fails and returning
that single error.
Signed-off-by: Milas Bowman <milas.bowman@docker.com>
2023-08-31 16:47:14 +02:00
|
|
|
psRes := cli.RunDockerComposeCmd(t, "ps", "--all", "--format=json", service)
|
2023-08-22 09:26:09 +02:00
|
|
|
var svc map[string]interface{}
|
|
|
|
require.NoError(t, json.Unmarshal([]byte(psRes.Stdout()), &svc),
|
up: fix various race/deadlock conditions on exit (#10934)
If running `up` in foreground mode (i.e. not `-d`),
when exiting via `Ctrl-C`, Compose stops all the
services it launched directly as part of that `up`
command.
In one of the E2E tests (`TestUpDependenciesNotStopped`),
this was occasionally flaking because the stop
behavior was racy: the return might not block on
the stop operation because it gets added to the
error group in a goroutine. As a result, it was
possible for no services to get terminated on exit.
There were a few other related pieces here that
I uncovered and tried to fix while stressing this.
For example, the printer could cause a deadlock if
an event was sent to it after it stopped.
Also, an error group wasn't really appropriate here;
each goroutine is a different operation for printing,
signal-handling, etc. If one part fails, we don't
actually want printing to stop, for example. This has
been switched to a `multierror.Group`, which has the
same API but coalesces errors instead of canceling a
context the moment the first one fails and returning
that single error.
Signed-off-by: Milas Bowman <milas.bowman@docker.com>
2023-08-31 16:47:14 +02:00
|
|
|
"Invalid `compose ps` JSON: command output: %s",
|
|
|
|
psRes.Combined())
|
2022-08-02 21:25:59 +02:00
|
|
|
|
2023-08-22 09:26:09 +02:00
|
|
|
require.Equal(t, service, svc["Service"],
|
|
|
|
"Found ps output for unexpected service")
|
|
|
|
require.Equalf(t,
|
|
|
|
strings.ToLower(state),
|
|
|
|
strings.ToLower(svc["State"].(string)),
|
|
|
|
"Service %q (%s) not in expected state",
|
|
|
|
service, svc["Name"],
|
|
|
|
)
|
2022-08-02 21:25:59 +02:00
|
|
|
}
|