Need to install pkg-config apt package in all IDAs that use Python mysqlclient

[timmc-edx]

Symptom

Repos that depend on mysqlclient>=2.2.0 will need to install the package pkg-config in their Dockerfile: PyMySQL/mysqlclient#620

If this is missing, then pip install of mysqlclient fails with an error that includes the following:

Exception: Can not find valid pkg-config name.
Specify MYSQLCLIENT_CFLAGS and MYSQLCLIENT_LDFLAGS env vars manually

Fix

• In the Dockerfile, include pkg-config in the list of packages installed by apt
  • Put the package name close to libssl-dev and libmysqlclient-dev, which are also required by mysqlclient, and likely already present
  • Include a comment (on its own line) to the effect of # mysqlclient>=2.2.0 requires pkg-config to explain the addition
• Because this may introduce tzdata as a new system dependency, and tzdata requests manual configuration, you may need to include DEBIAN_FRONTEND=noninteractive at the front of the apt install line in order to not have docker image building hang. (It's possible that --no-install-recommends would suffice, if missing, but no harm in using both.)

So, that part of your Dockerfile may end up looking something like:

RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -qy --no-install-recommends \
    python3.8 python3-pip \
    ...
    # mysqlcient dependencies:
    libmysqlclient-dev build-essential pkg-config libssl-dev \
    && rm -rf /var/lib/apt/lists/*

Affected repos

For reference, the following repos have Dockerfiles that reference libmysqlclient-dev, another known apt package dependency for the mysqlclient Python dep (broken out by 2U ownership):

• aperture:
  • edx/demographics Pull Request
  • openedx/credentials Pull Request
• arch-bom:
  • openedx/edx-cookiecutters (cookiecutter-django-ida/{{cookiecutter.repo_name}}/Dockerfile): Issue
  • openedx/edx-platform - thought we'd fixed this, but there are two apt-install blocks in different Docker stages...
  • openedx/edx-repo-health (tests/fake_repos/python_repo/Dockerfile): Issue
• aurora:
  • openedx/edx-notes-api chore: install pkg-config for PyMySQL compatibility openedx/edx-notes-api#339
  • openedx/xqueue chore: install pkg-config for PyMySQL compatibility openedx/xqueue#894
• Someone else in the Open edX community:
  • openedx/openedx-i18n (docker/Dockerfile)
• cosmonauts:
  • edx/edx-exams
  • edx/portal-designer
  • edx/program-intent-engagement
  • openedx/edx-analytics-dashboard
  • openedx/edx-analytics-data-api
  • openedx/registrar
• phoenix:
  • edx/financial-assistance
  • edx/video-encode-manager
  • openedx/course-discovery
• purchase:
  • edx/commerce-coordinator
  • openedx/ecommerce
• sre:
  • edx/internal-dockerfiles (gocd-agents/Dockerfile) PR
  • edx/monitoring-scripts PR
• titans:
  • edx/subscriptions
  • openedx/edx-enterprise
  • openedx/enterprise-access
  • openedx/enterprise-catalog
  • openedx/enterprise-subsidy
  • openedx/license-manager - Pull request

[MichaelRoytman]

I've updated the Cosmonauts Dockerfiles and checked off the associated checkboxes above. Thank you!

[rgraber]

Closing on the grounds that we have told everyone about the necessary changes and merged all the PRs we are responsible for creating.