feat: Add enterprise subsidy service to Devstack

edx · Nov 26, 2024 · 731be3f · 731be3f
1 parent 4255f6a
commit 731be3f
Show file tree

Hide file tree

Showing 11 changed files with 75 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -407,6 +407,9 @@ dev.shell.analyticsapi:
 dev.shell.insights:
 	docker compose exec insights env TERM=$(TERM) bash -c 'eval $$(source /edx/app/insights/insights_env; echo PATH="$$PATH";) && /bin/bash'
 
+dev.shell.enterprise-subsidy:
+	docker compose exec enterprise-subsidy env TERM=$(TERM) bash -c '/bin/bash'
+
 dev.shell.%: ## Run a shell on the specified service's container.
 	docker compose exec $* /bin/bash
 

diff --git 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 enterprise-subsidy; then
+    echo "Running Enterprise Subsidy Devstack tests: "
+    run_check enterprise-subsidy_heartbeat enterprise-subsidy \
+        "curl --fail -L http://localhost:18280/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
@@ -71,6 +71,10 @@ services:
       - ${DEVSTACK_WORKSPACE}/edx-analytics-data-api:/edx/app/analytics_api/analytics_api
       - ${DEVSTACK_WORKSPACE}/src:/edx/src
       - ${PWD}/py_configuration_files/analytics_data_api.py:/edx/app/analytics_api/analytics_api/analyticsdataserver/settings/devstack.py
+  enterprise-subsidy:
+    volumes:
+      - ${DEVSTACK_WORKSPACE}/enterprise-subsidy:/edx/app/enterprise-subsidy
+      - ${DEVSTACK_WORKSPACE}/src:/edx/src
 
   # Note that frontends mount `src` to /edx/app/src instead of /edx/src.
   # See ADR #5 for rationale.

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -693,6 +693,29 @@ services:
         aliases:
           - edx.devstack.xqueue_consumer
 
+  enterprise-subsidy:
+    image: edxops/enterprise-subsidy-dev
+    container_name: edx.devstack.enterprise-subsidy
+    hostname: enterprise-subsidy.devstack.edx
+    depends_on:
+      - mysql80
+      - memcached
+    command: bash -c 'while true; do python /edx/app/enterprise-subsidy/manage.py runserver 0.0.0.0:18280; sleep 2; done'
+    stdin_open: true
+    tty: true
+    environment:
+      DB_HOST: edx.devstack.mysql80
+      DB_PORT: 3306
+      DB_USER: subsidy001
+      DB_PASSWORD: password
+      DJANGO_SETTINGS_MODULE: enterprise_subsidy.settings.devstack
+      MEMCACHE_HOST: memcached.devstack.edx:11211
+    working_dir: /edx/app/enterprise-subsidy
+    ports:
+      - "18280:18280"
+    volumes:
+      - /edx/var/enterprise-subsidy
+
   # ==========================================================================
   # edX Microfrontends
   #

diff --git a/docs/service_list.rst b/docs/service_list.rst
@@ -63,6 +63,8 @@ Instead of a service name or list, you can also run commands like ``make dev.pro
 +------------------------------------+-------------------------------------+----------------+--------------+
 | `frontend-app-ora-grading`_        | http://localhost:1993               | MFE (React.js) | Extra        |
 +------------------------------------+-------------------------------------+----------------+--------------+
+| `enterprise-subsidy`_              | http://localhost:18280              | Python/Django  | Extra        |
++------------------------------------+-------------------------------------+----------------+--------------+
 
 Some common service combinations include:
 
@@ -95,3 +97,4 @@ Some common service combinations include:
 .. _frontend-app-ora-grading: https://github.com/edx/frontend-app-ora-grading
 .. _insights: https://github.com/edx/edx-analytics-dashboard
 .. _analyticsapi: https://github.com/edx/edx-analytics-data-api
+.. _enterprise-subsidy: https://github.com/openedx/enterprise-subsidy
diff --git 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
+analyticsapi+enterprise-subsidy+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
 
 # Services with database migrations.
 # Should be a subset of $(EDX_SERVICES).

diff --git a/provision-enterprise-subsidy.sh b/provision-enterprise-subsidy.sh
@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+set -eu -o pipefail
+set -x
+
+. scripts/colors.sh
+
+name="enterprise-subsidy"
+port="18280"
+
+docker compose up -d lms
+docker compose up -d ${name}
+
+# Run migrations
+echo -e "${GREEN}Running migrations for ${name}...${NC}"
+docker compose exec ${name} bash -c "cd /edx/app/${name}/ && make migrate"
+
+# Create superuser
+echo -e "${GREEN}Creating super-user for ${name}...${NC}"
+docker compose exec ${name} bash -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/${name}/manage.py shell"
+
+# Provision IDA User in LMS
+echo -e "${GREEN}Provisioning ${name}_worker in LMS...${NC}"
+
+./provision-ida-user.sh ${name} ${name} ${port}
diff --git a/provision-mysql80.sql b/provision-mysql80.sql
@@ -45,4 +45,8 @@ CREATE USER IF NOT EXISTS 'edxapp001'@'%' IDENTIFIED BY 'password';
 GRANT ALL ON edxapp.* TO 'edxapp001'@'%';
 GRANT ALL ON edxapp_csmh.* TO 'edxapp001'@'%';
 
+CREATE DATABASE IF NOT EXISTS enterprise_subsidy;
+CREATE USER IF NOT EXISTS 'subsidy001'@'%' IDENTIFIED BY 'password';
+GRANT ALL ON enterprise_subsidy.* TO 'subsidy001'@'%';
+
 FLUSH PRIVILEGES;
diff --git a/provision.sh b/provision.sh
@@ -49,6 +49,7 @@ xqueue \
 coursegraph \
 insights \
 analyticsapi \
+enterprise-subsidy \
  "
 
 # What should we provision?

diff --git a/provision.sql b/provision.sql
@@ -33,5 +33,9 @@ GRANT ALL ON `reports`.* TO 'analytics001'@'%' IDENTIFIED BY 'password';
 CREATE DATABASE IF NOT EXISTS `reports_v1`;
 GRANT ALL ON `reports_v1`.* TO 'analytics001'@'%' IDENTIFIED BY 'password';
 
+CREATE DATABASE IF NOT EXISTS enterprise_subsidy;
+CREATE USER IF NOT EXISTS 'subsidy001'@'%' IDENTIFIED BY 'password';
+GRANT ALL ON enterprise_subsidy.* TO 'subsidy001'@'%';
+
 
 FLUSH PRIVILEGES;
diff --git a/repo.sh b/repo.sh
@@ -48,6 +48,7 @@ non_release_repos=(
     "https://github.com/openedx/frontend-app-account.git"
     "https://github.com/openedx/frontend-app-profile.git"
     "https://github.com/openedx/frontend-app-ora-grading.git"
+    "https://github.com/openedx/enterprise-subsidy.git"
 )
 
 ssh_repos=(
@@ -78,6 +79,7 @@ non_release_ssh_repos=(
     "git@github.com:openedx/frontend-app-account.git"
     "git@github.com:openedx/frontend-app-profile.git"
     "git@github.com:openedx/frontend-app-ora-grading.git"
+    "git@github.com:openedx/enterprise-subsidy.git"
 )
 
 if [ -n "${OPENEDX_RELEASE}" ]; then