diff --git a/.github/workflows/provisioning-tests.yml b/.github/workflows/provisioning-tests.yml index d8fc8ce00f..82963d0d35 100644 --- a/.github/workflows/provisioning-tests.yml +++ b/.github/workflows/provisioning-tests.yml @@ -30,7 +30,7 @@ jobs: os: - ubuntu-20.04 # Ubuntu 20.04 "Focal Fossa" python-version: [ '3.11' ] - services: [ discovery+lms+forum ,registrar+lms, ecommerce+lms, edx_notes_api+lms, credentials+lms, xqueue, analyticsapi+insights+lms, enterprise-catalog+lms] + services: [ discovery+lms+forum ,registrar+lms, ecommerce+lms, edx_notes_api+lms, credentials+lms, xqueue, analyticsapi+insights+lms, enterprise-catalog+lms, license-manager+lms] fail-fast: false # some services can be flaky; let others run to completion even if one fails steps: diff --git a/check.sh b/check.sh index 3c0781f025..f010e39299 100755 --- a/check.sh +++ b/check.sh @@ -156,6 +156,12 @@ if should_check analyticsapi; then "curl --fail -L http://localhost:19001/health/" fi +if should_check license-manager; then + echo "Running License Manager Devstack tests: " + run_check license_manager_heartbeat license-manager \ + "curl --fail -L http://localhost:18170/health/" +fi + echo "Successful checks:${succeeded:- NONE}" echo "Failed checks:${failed:- NONE}" if [[ -z "$succeeded" ]] && [[ -z "$failed" ]]; then diff --git a/docker-compose-host.yml b/docker-compose-host.yml index ee11a203cd..7690fc5a81 100644 --- a/docker-compose-host.yml +++ b/docker-compose-host.yml @@ -81,6 +81,21 @@ services: enterprise-catalog-curations-worker: volumes: - ${DEVSTACK_WORKSPACE}/enterprise-catalog:/edx/app/enterprise_catalog/enterprise_catalog + license-manager: + volumes: + - ${DEVSTACK_WORKSPACE}/license-manager:/edx/app/license_manager + - ${DEVSTACK_WORKSPACE}/src:/edx/src:cached + - ${PWD}/py_configuration_files/license_manager.py:/edx/app/license_manager/license_manager/settings/devstack.py + license-manager-worker: + volumes: + - ${DEVSTACK_WORKSPACE}/license-manager:/edx/app/license_manager + - ${DEVSTACK_WORKSPACE}/src:/edx/src:cached + - ${PWD}/py_configuration_files/license_manager.py:/edx/app/license_manager/license_manager/settings/devstack.py + bulk-enrollment-worker: + volumes: + - ${DEVSTACK_WORKSPACE}/license-manager:/edx/app/license_manager + - ${DEVSTACK_WORKSPACE}/src:/edx/src:cached + - ${PWD}/py_configuration_files/license_manager.py:/edx/app/license_manager/license_manager/settings/devstack.py # Note that frontends mount `src` to /edx/app/src instead of /edx/src. # See ADR #5 for rationale. frontend-app-account: diff --git a/docker-compose.yml b/docker-compose.yml index 85dbf7f863..a155675a46 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -769,6 +769,72 @@ services: stdin_open: true tty: true + license-manager: + image: edxops/license-manager-dev:latest + container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.license-manager" + hostname: license-manager.devstack.edx + # Use the Django devserver, so that we can hot-reload code changes + command: bash -c 'while true; do python /edx/app/license_manager/manage.py runserver 0.0.0.0:18170; sleep 2; done' + ports: + - "18170:18170" + depends_on: + - mysql80 + - license-manager-worker + # Allows attachment to this container using 'docker attach '. + stdin_open: true + tty: true + environment: + CELERY_ALWAYS_EAGER: 'false' + CELERY_BROKER_TRANSPORT: redis + CELERY_BROKER_HOSTNAME: edx.devstack.redis:6379 + CELERY_BROKER_VHOST: 0 + CELERY_BROKER_PASSWORD: password + DJANGO_SETTINGS_MODULE: license_manager.settings.devstack + DJANGO_WATCHMAN_TIMEOUT: 30 + ENABLE_DJANGO_TOOLBAR: 1 + + license-manager-worker: + image: edxops/license-manager-dev:latest + command: bash -c 'cd /edx/app/license_manager/license_manager && celery -A license_manager worker -Q license_manager.default -l DEBUG' + container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.license-manager-worker" + hostname: license-manager-worker.devstack.edx + depends_on: + - mysql80 + environment: + CELERY_ALWAYS_EAGER: 'false' + CELERY_BROKER_TRANSPORT: redis + CELERY_BROKER_HOSTNAME: edx.devstack.redis:6379 + CELERY_BROKER_VHOST: 0 + CELERY_BROKER_PASSWORD: password + DJANGO_SETTINGS_MODULE: license_manager.settings.devstack + COLUMNS: 80 + ports: + - "18171:18171" + restart: always + stdin_open: true + tty: true + + bulk-enrollment-worker: + image: edxops/license-manager-dev:latest + command: bash -c 'cd /edx/app/license_manager/license_manager && celery -A license_manager worker -Q license_manager.bulk_enrollment -l DEBUG' + container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.license-manager.bulk-enrollment-worker" + hostname: license-manager.bulk-enrollment-worker.devstack.edx + depends_on: + - mysql80 + environment: + CELERY_ALWAYS_EAGER: 'false' + CELERY_BROKER_TRANSPORT: redis + CELERY_BROKER_HOSTNAME: edx.devstack.redis:6379 + CELERY_BROKER_VHOST: 0 + CELERY_BROKER_PASSWORD: password + DJANGO_SETTINGS_MODULE: license_manager.settings.devstack + COLUMNS: 80 + ports: + - "18172:18172" + restart: always + stdin_open: true + tty: true + # ========================================================================== # edX Microfrontends # diff --git a/docs/service_list.rst b/docs/service_list.rst index fd750f117a..930465758c 100644 --- a/docs/service_list.rst +++ b/docs/service_list.rst @@ -61,6 +61,8 @@ Instead of a service name or list, you can also run commands like ``make dev.pro +------------------------------------+-------------------------------------+----------------+--------------+ | `analyticsapi`_ | http://localhost:19001 | Python/Django | Extra | +------------------------------------+-------------------------------------+----------------+--------------+ +| `license-manager`_ | http://localhost:18171 | Python/Django | Extra | ++------------------------------------+-------------------------------------+----------------+--------------+ | `frontend-app-ora-grading`_ | http://localhost:1993 | MFE (React.js) | Extra | +------------------------------------+-------------------------------------+----------------+--------------+ | `enterprise-catalog`_ | http://localhost:18160/ | Python/Django | Extra | @@ -98,3 +100,4 @@ Some common service combinations include: .. _insights: https://github.com/edx/edx-analytics-dashboard .. _analyticsapi: https://github.com/edx/edx-analytics-data-api .. _enterprise-catalog: https://github.com/openedx/enterprise-catalog +.. _license-manager: https://github.com/openedx/license-manager diff --git a/options.mk b/options.mk index ad7449435b..bf3b0cd7d5 100644 --- a/options.mk +++ b/options.mk @@ -67,7 +67,7 @@ credentials+discovery+ecommerce+edx_notes_api+forum+frontend-app-authn+frontend- # Separated by plus signs. # Separated by plus signs. Listed in alphabetical order for clarity. EDX_SERVICES ?= \ -analyticsapi+credentials+cms+cms-worker+cms_watcher+discovery+ecommerce+edx_notes_api+forum+frontend-app-account+frontend-app-learner-dashboard+frontend-app-learner-record+frontend-app-profile+frontend-app-authn+frontend-app-course-authoring+frontend-app-gradebook+frontend-app-ora-grading+frontend-app-learning+frontend-app-library-authoring+frontend-app-payment+frontend-app-program-console+frontend-app-publisher+insights+lms+lms-worker+lms_watcher+registrar+registrar-worker+xqueue+xqueue_consumer+enterprise-catalog +analyticsapi+credentials+cms+cms-worker+cms_watcher+discovery+ecommerce+edx_notes_api+forum+frontend-app-account+frontend-app-learner-dashboard+frontend-app-learner-record+frontend-app-profile+frontend-app-authn+frontend-app-course-authoring+frontend-app-gradebook+frontend-app-ora-grading+frontend-app-learning+frontend-app-library-authoring+frontend-app-payment+frontend-app-program-console+frontend-app-publisher+insights+lms+lms-worker+lms_watcher+registrar+registrar-worker+xqueue+xqueue_consumer+enterprise-catalog+license-manager # Services with database migrations. # Should be a subset of $(EDX_SERVICES). @@ -76,7 +76,7 @@ analyticsapi+credentials+cms+cms-worker+cms_watcher+discovery+ecommerce+edx_note # Note: This list should contain _all_ db-backed services, even if not # configured to run; the list will be filtered later against $(DEFAULT_SERVICES). DB_SERVICES ?= \ -credentials+cms+discovery+ecommerce+lms+registrar +credentials+cms+discovery+ecommerce+lms+registrar+license-manager # Services with static assets to be built. # Should be a subset of $(EDX_SERVICES). diff --git a/provision-license-manager.sh b/provision-license-manager.sh new file mode 100755 index 0000000000..b57ae085d8 --- /dev/null +++ b/provision-license-manager.sh @@ -0,0 +1,33 @@ +#!/usr/bin/env bash +# Provisioning script for the notes service +set -eu -o pipefail + +. scripts/colors.sh +set -x + +name=license-manager +port=18170 + +docker compose up -d $name +docker compose up -d lms + +echo -e "${GREEN}Installing requirements for ${name}...${NC}" +docker compose exec -T ${name} bash -e -c 'cd /edx/app/license_manager/ && make requirements' -- "$name" +# Run migrations +echo -e "${GREEN}Running migrations for ${name}...${NC}" +docker compose exec -T ${name} bash -e -c "cd /edx/app/license_manager/ && make migrate" -- "$name" + +# Seed data for development +echo -e "${GREEN}Seeding development data..." +docker compose exec -T ${name} bash -e -c "python manage.py seed_development_data" -- "$name" +# Some migrations require development data to be seeded, hence migrating again. +docker compose exec -T ${name} bash -e -c "make migrate" -- "$name" + +# Create superuser +echo -e "${GREEN}Creating super-user for ${name}...${NC}" +docker compose exec -T ${name} bash -e -c "echo 'from django.contrib.auth import get_user_model; User = get_user_model(); User.objects.create_superuser(\"edx\", \"edx@example.com\", \"edx\") if not User.objects.filter(username=\"edx\").exists() else None' | python /edx/app/license_manager/manage.py shell" -- "$name" + +# Provision IDA User in LMS +./provision-ida-user.sh ${name} ${name} $port + +make dev.restart-devserver.license-manager diff --git a/provision-mysql80.sql b/provision-mysql80.sql index be903f1d7f..724a84bb39 100644 --- a/provision-mysql80.sql +++ b/provision-mysql80.sql @@ -43,6 +43,10 @@ GRANT ALL ON `reports`.* TO 'analytics001'@'%'; CREATE DATABASE IF NOT EXISTS `reports_v1`; GRANT ALL ON `reports_v1`.* TO 'analytics001'@'%'; +CREATE DATABASE IF NOT EXISTS license_manager; +CREATE USER IF NOT EXISTS 'license_manager001'@'%' IDENTIFIED BY 'password'; +GRANT ALL ON license_manager.* TO 'license_manager001'@'%'; + CREATE DATABASE IF NOT EXISTS edxapp; CREATE DATABASE IF NOT EXISTS edxapp_csmh; CREATE USER IF NOT EXISTS 'edxapp001'@'%' IDENTIFIED BY 'password'; diff --git a/provision.sh b/provision.sh index 551349ed68..d27a2d6f33 100755 --- a/provision.sh +++ b/provision.sh @@ -50,6 +50,7 @@ coursegraph \ insights \ analyticsapi \ enterprise-catalog \ +license-manager \ " # What should we provision? diff --git a/provision.sql b/provision.sql index 94c3fd48c0..c0d3a96d64 100644 --- a/provision.sql +++ b/provision.sql @@ -36,4 +36,7 @@ GRANT ALL ON `reports_v1`.* TO 'analytics001'@'%' IDENTIFIED BY 'password'; CREATE DATABASE IF NOT EXISTS `enterprise_catalog`; GRANT ALL ON `enterprise_catalog`.* TO 'catalog001'@'%' IDENTIFIED BY 'password'; +CREATE DATABASE IF NOT EXISTS license_manager; +GRANT ALL ON license_manager.* TO 'license_manager001'@'%' IDENTIFIED BY 'password'; + FLUSH PRIVILEGES; diff --git a/py_configuration_files/license_manager.py b/py_configuration_files/license_manager.py index 468e623f87..ca72fa6be8 100644 --- a/py_configuration_files/license_manager.py +++ b/py_configuration_files/license_manager.py @@ -9,11 +9,11 @@ DATABASES = { 'default': { 'ENGINE': 'django.db.backends.mysql', - 'NAME': 'license_manager', - 'USER': 'root', - 'PASSWORD': '', - 'HOST': 'license-manager.mysql', - 'PORT': '3306', + 'NAME': os.environ.get('DB_NAME', 'license_manager'), + 'USER': os.environ.get('DB_USER', 'license_manager001'), + 'PASSWORD': os.environ.get('DB_PASSWORD', 'password'), + 'HOST': os.environ.get('DB_HOST', 'edx.devstack.mysql80'), + 'PORT': os.environ.get('DB_PORT', 3306), } } diff --git a/repo.sh b/repo.sh index 84792fb35c..7a31b729db 100755 --- a/repo.sh +++ b/repo.sh @@ -37,6 +37,7 @@ repos=( "https://github.com/edx/edx-analytics-dashboard.git" "https://github.com/edx/edx-analytics-data-api.git" "https://github.com/openedx/enterprise-catalog.git" + "https://github.com/openedx/license-manager.git" ) non_release_repos=( @@ -68,6 +69,7 @@ ssh_repos=( "git@github.com:openedx/frontend-app-publisher.git" "git@github.com:edx/edx-analytics-dashboard.git" "git@github.com:edx/edx-analytics-data-api.git" + "git@github.com:openedx/license-manager.git" ) non_release_ssh_repos=(