Example of depends_on usage required

[flyte]

File: docker-hub/builds/automated-testing.md

It's unclear how to actually use the depends_on feature described in this automated-testing documentation.

If I add some services and a depends_on to sut then I get:

The Compose file './docker-compose-test.yml' is invalid because:
Unsupported config option for sut: 'depends_on'
building docker-compose-test.yml (1)

using the following docker-compose-test.yml file:

sut:
  build: .
  command: ./run_tests.sh
  depends_on:
    - db
db:
  image: postgis/postgis:12-3.1-alpine
  environment:
    POSTGRES_PASSWORD: pgpassword
  expose:
    - "5432"

[flyte]

I've managed to work it out by using a versioned docker-compose file:

version: "3.9"

services:
  sut:
    build: .
    command: ./run_tests.sh
    depends_on:
      - db
  db:
    image: postgis/postgis:12-3.1-alpine
    environment:
      POSTGRES_PASSWORD: pgpassword
    expose:
      - "5432"

[danBamikiya]

@flyte Hi, depends_on was implemented in version 2 so to use that feature you'll have to specify compose file version from version 2.0 upward. A non-versioned compose file has a default version of 0.

If this issue is solved, you should close this issue 🙂.

[flyte]

@danBamikiya thanks. I left it open because even though I worked it out, an example in the documentation would still be useful.

[danBamikiya]

@flyte what kind of example?

[flyte]

There should be a note on https://docs.docker.com/docker-hub/builds/automated-testing/ saying what you said just now. Or at the very least, add the version to the example given there.

[danBamikiya]

@flyte What if we provide a link to the depends_on reference. For example:

Note: Only the sut service and all other services listed in depends_on are started.
For instance, if you have services that poll for changes in other services, be sure to include the polling services in the depends_on list to make sure all of your services start.

I think that should work for readers right?

[flyte]

I think it's still not explicit that the version is required for this to work. It's not a given that people (me) will make the link between having to set the version number in the docker compose file and the functionality working.

There was also the issue of having to nest the services inside a 'services' block, despite what the example shows. There was nothing to suggest that this would be an acceptable format for the automated testing, since the minimal example given does not do that.

[docker-robott]

Closed issues are locked after 30 days of inactivity.
This helps our team focus on active issues.

If you have found a problem that seems similar to this, please open a new issue.

/lifecycle locked