Make API endpoints available (#1908)

* Make API enpoints available

* Update CI/CD

* Update backend/tests/apps/common/utils_test.py

---------

Co-authored-by: Kate Golovanova <[email protected]>

Author: arkid15r

.github/workflows/run-ci-cd.yaml

@@ -176,7 +176,7 @@ jobs:
 
       - name: Run backend tests
         run: |
-          docker run -e DJANGO_CONFIGURATION=Test owasp/nest:test-backend-latest pytest
+          docker run -e DJANGO_SETTINGS_MODULE=settings.test --env-file backend/.env.example owasp/nest:test-backend-latest pytest
 
   run-frontend-unit-tests:
     name: Run frontend unit tests

backend/Makefile

@@ -116,7 +116,10 @@ test-backend:
 		--cache-from nest-test-backend \
 		-f backend/docker/Dockerfile.test backend \
 		-t nest-test-backend
-	@docker run -e DJANGO_CONFIGURATION=Test --rm nest-test-backend pytest
+	@docker run \
+		-e DJANGO_SETTINGS_MODULE=settings.test \
+		--env-file backend/.env.example \
+		--rm nest-test-backend pytest
 
 update-backend-dependencies:
 	@cd backend && poetry update

backend/apps/common/index.py

@@ -29,7 +29,6 @@
     "projects_updated_at_asc",
     "projects_updated_at_desc",
 )
-IS_LOCAL_BUILD = settings.ENVIRONMENT == "Local"
 LOCAL_INDEX_LIMIT = 1000
 
 
@@ -60,7 +59,11 @@ def is_indexable(self, name: str) -> bool:
             bool: True if the index is enabled, False otherwise.
 
         """
-        return name.lower() not in self.excluded_local_index_names if IS_LOCAL_BUILD else True
+        return (
+            name.lower() not in self.excluded_local_index_names
+            if settings.IS_LOCAL_ENVIRONMENT
+            else True
+        )
 
     def load_excluded_local_index_names(self) -> IndexRegistry:
         """Load excluded local index names from settings.
@@ -285,4 +288,4 @@ def get_queryset(self):
         """
         qs = self.get_entities()
 
-        return qs[:LOCAL_INDEX_LIMIT] if IS_LOCAL_BUILD else qs
+        return qs[:LOCAL_INDEX_LIMIT] if settings.IS_LOCAL_ENVIRONMENT else qs

backend/apps/common/utils.py

@@ -78,7 +78,7 @@ def get_user_ip_address(request) -> str:
         str: The user's IP address.
 
     """
-    if settings.ENVIRONMENT == "Local":
+    if settings.IS_LOCAL_ENVIRONMENT:
         return settings.PUBLIC_IP_ADDRESS
 
     x_forwarded_for = request.META.get("HTTP_X_FORWARDED_FOR")

backend/apps/owasp/models/mixins/project.py

@@ -40,7 +40,7 @@ def idx_forks_count(self) -> int:
     def idx_health_score(self) -> float | None:
         """Return health score for indexing."""
         # TODO(arkid15r): Enable real health score in production when ready.
-        return 100 if settings.ENVIRONMENT == "Production" else self.health_score
+        return 100 if settings.IS_PRODUCTION_ENVIRONMENT else self.health_score
 
     @property
     def idx_is_active(self) -> bool:

backend/settings/api/v1.py

@@ -1,22 +1,28 @@
 """OWASP Nest API v1 configuration."""
 
+from django.conf import settings
 from ninja import NinjaAPI, Swagger
 from ninja.throttling import AuthRateThrottle
 
 from apps.core.api.ninja import ApiKeyAuth
 from apps.github.api.rest.v1.urls import router as github_router
 from apps.owasp.api.rest.v1.urls import router as owasp_router
 
-api = NinjaAPI(
-    auth=ApiKeyAuth(),
-    description="API for OWASP related entities",
-    docs=Swagger(settings={"persistAuthorization": True}),
-    throttle=[
-        AuthRateThrottle("10/s"),
-    ],
-    title="OWASP Nest API",
-    version="1.0.0",
-)
+api_settings = {
+    "description": "Open Worldwide Application Security Project API",
+    "docs": Swagger(settings={"persistAuthorization": True}),
+    "title": "OWASP Nest",
+    "version": "1.0.0",
+}
+if not settings.IS_LOCAL_ENVIRONMENT:
+    api_settings.update(
+        {
+            "auth": ApiKeyAuth(),
+            "throttle": [AuthRateThrottle("10/s")],
+        }
+    )
+
+api = NinjaAPI(**api_settings)
 
 api.add_router("github", github_router)
 api.add_router("owasp", owasp_router)

backend/settings/base.py

@@ -12,15 +12,17 @@ class Base(Configuration):
     BASE_DIR = Path(__file__).resolve().parent.parent
 
     ENVIRONMENT = os.environ.get("DJANGO_CONFIGURATION", "Local")
-    if ENVIRONMENT == "Test":
-        from dotenv import load_dotenv
-
-        load_dotenv(BASE_DIR / ".env.example")
 
     ALLOWED_HOSTS = values.ListValue()
     AUTH_USER_MODEL = "nest.User"
     CORS_ALLOW_CREDENTIALS = True
     DEBUG = False
+
+    IS_LOCAL_ENVIRONMENT = False
+    IS_PRODUCTION_ENVIRONMENT = False
+    IS_STAGING_ENVIRONMENT = False
+    IS_TEST_ENVIRONMENT = False
+
     RELEASE_VERSION = values.Value(environ_name="RELEASE_VERSION")
     SENTRY_DSN = values.SecretValue(environ_name="SENTRY_DSN")
 
@@ -44,6 +46,7 @@ class Base(Configuration):
     THIRD_PARTY_APPS = (
         "algoliasearch_django",
         "corsheaders",
+        "ninja",
         "storages",
     )
 

backend/settings/local.py

@@ -18,6 +18,7 @@ class Local(Base):
     CSRF_TRUSTED_ORIGINS = ALLOWED_ORIGINS
 
     DEBUG = True
+    IS_LOCAL_ENVIRONMENT = True
     LOGGING = {}
     PUBLIC_IP_ADDRESS = values.Value()
     SLACK_COMMANDS_ENABLED = True

backend/settings/production.py

@@ -47,5 +47,7 @@ class Production(Base):
     CORS_ALLOWED_ORIGINS = ALLOWED_ORIGINS
     CSRF_TRUSTED_ORIGINS = ALLOWED_ORIGINS
 
+    IS_PRODUCTION_ENVIRONMENT = True
+
     SLACK_COMMANDS_ENABLED = True
     SLACK_EVENTS_ENABLED = True

backend/settings/staging.py

@@ -47,5 +47,7 @@ class Staging(Base):
     CORS_ALLOWED_ORIGINS = ALLOWED_ORIGINS
     CSRF_TRUSTED_ORIGINS = ALLOWED_ORIGINS
 
+    IS_STAGING_ENVIRONMENT = True
+
     SLACK_COMMANDS_ENABLED = True
     SLACK_EVENTS_ENABLED = True