move include/global_project to adapters (#8930)

.changes/unreleased/Under the Hood-20231026-184953.yaml

@@ -0,0 +1,6 @@
+kind: Under the Hood
+body: Remove usage of dbt.include.global_project in dbt/adapters
+time: 2023-10-26T18:49:53.36449-04:00
+custom:
+  Author: michelleark
+  Issue: "8925"

.gitattributes

@@ -1,4 +1,4 @@
-core/dbt/include/index.html binary
+core/dbt/task/docs/index.html binary
 tests/functional/artifacts/data/state/*/manifest.json binary
 core/dbt/docs/build/html/searchindex.js binary
 core/dbt/docs/build/html/index.html binary

ARCHITECTURE.md

@@ -26,7 +26,7 @@ Legacy tests are found in the 'test' directory:
 
 The "tasks" map to top-level dbt commands. So `dbt run` => task.run.RunTask, etc. Some are more like abstract base classes (GraphRunnableTask, for example) but all the concrete types outside of task should map to tasks. Currently one executes at a time. The tasks kick off their “Runners” and those do execute in parallel. The parallelism is managed via a thread pool, in GraphRunnableTask.
 
-core/dbt/include/index.html
+core/dbt/task/docs/index.html
 This is the docs website code. It comes from the dbt-docs repository, and is generated when a release is packaged.
 
 ## Adapters

core/dbt/adapters/factory.py

@@ -11,8 +11,8 @@
 from dbt.common.events.functions import fire_event
 from dbt.adapters.events.types import AdapterImportError, PluginLoadError, AdapterRegistered
 from dbt.common.exceptions import DbtInternalError, DbtRuntimeError
-from dbt.include.global_project import PACKAGE_PATH as GLOBAL_PROJECT_PATH
-from dbt.include.global_project import PROJECT_NAME as GLOBAL_PROJECT_NAME
+from dbt.adapters.include.global_project import PACKAGE_PATH as GLOBAL_PROJECT_PATH
+from dbt.adapters.include.global_project import PROJECT_NAME as GLOBAL_PROJECT_NAME
 from dbt.semver import VersionSpecifier
 from dbt.mp_context import get_mp_context
 

core/dbt/adapters/include/global_project/__init__.py

@@ -0,0 +1,4 @@
+import os
+
+PACKAGE_PATH = os.path.dirname(__file__)
+PROJECT_NAME = "dbt"

core/dbt/cli/main.py

@@ -28,15 +28,15 @@
 from dbt.task.compile import CompileTask
 from dbt.task.debug import DebugTask
 from dbt.task.deps import DepsTask
+from dbt.task.docs.generate import GenerateTask
+from dbt.task.docs.serve import ServeTask
 from dbt.task.freshness import FreshnessTask
-from dbt.task.generate import GenerateTask
 from dbt.task.init import InitTask
 from dbt.task.list import ListTask
 from dbt.task.retry import RetryTask
 from dbt.task.run import RunTask
 from dbt.task.run_operation import RunOperationTask
 from dbt.task.seed import SeedTask
-from dbt.task.serve import ServeTask
 from dbt.task.show import ShowTask
 from dbt.task.snapshot import SnapshotTask
 from dbt.task.test import TestTask

core/dbt/context/macro_resolver.py

@@ -1,7 +1,7 @@
 from typing import Dict, MutableMapping, Optional
 from dbt.contracts.graph.nodes import Macro
 from dbt.exceptions import DuplicateMacroNameError, PackageNotFoundForMacroError
-from dbt.include.global_project import PROJECT_NAME as GLOBAL_PROJECT_NAME
+from dbt.adapters.include.global_project import PROJECT_NAME as GLOBAL_PROJECT_NAME
 from dbt.clients.jinja import MacroGenerator
 
 MacroNamespace = Dict[str, Macro]

core/dbt/context/macros.py

@@ -2,7 +2,7 @@
 
 from dbt.clients.jinja import MacroGenerator, MacroStack
 from dbt.contracts.graph.nodes import Macro
-from dbt.include.global_project import PROJECT_NAME as GLOBAL_PROJECT_NAME
+from dbt.adapters.include.global_project import PROJECT_NAME as GLOBAL_PROJECT_NAME
 from dbt.exceptions import DuplicateMacroNameError, PackageNotFoundForMacroError
 
 

core/dbt/task/docs/__init__.py

@@ -0,0 +1,3 @@
+import os
+
+DOCS_INDEX_FILE_PATH = os.path.normpath(os.path.join(os.path.dirname(__file__), "index.html"))

core/dbt/task/generate.py → core/dbt/task/docs/generate.py

@@ -7,7 +7,8 @@
 from dbt.common.dataclass_schema import ValidationError
 from dbt.clients.system import load_file_contents
 
-from .compile import CompileTask
+from dbt.task.docs import DOCS_INDEX_FILE_PATH
+from dbt.task.compile import CompileTask
 
 from dbt.adapters.factory import get_adapter
 from dbt.contracts.graph.nodes import ResultNode
@@ -28,7 +29,6 @@
 from dbt.exceptions import AmbiguousCatalogMatchError
 from dbt.graph import ResourceTypeSelector
 from dbt.node_types import NodeType
-from dbt.include.global_project import DOCS_INDEX_FILE_PATH
 from dbt.common.events.functions import fire_event
 from dbt.adapters.events.types import (
     WriteCatalogFailure,

core/dbt/task/serve.py → core/dbt/task/docs/serve.py

@@ -6,7 +6,7 @@
 
 import click
 
-from dbt.include.global_project import DOCS_INDEX_FILE_PATH
+from dbt.task.docs import DOCS_INDEX_FILE_PATH
 from dbt.task.base import ConfiguredTask
 
 

core/dbt/task/init.py

@@ -34,7 +34,7 @@
 
 from dbt.include.starter_project import PACKAGE_PATH as starter_project_directory
 
-from dbt.include.global_project import PROJECT_NAME as GLOBAL_PROJECT_NAME
+from dbt.adapters.include.global_project import PROJECT_NAME as GLOBAL_PROJECT_NAME
 
 from dbt.task.base import BaseTask, move_to_nearest_project_dir
 

core/dbt/task/retry.py

@@ -11,7 +11,7 @@
 from dbt.task.build import BuildTask
 from dbt.task.clone import CloneTask
 from dbt.task.compile import CompileTask
-from dbt.task.generate import GenerateTask
+from dbt.task.docs.generate import GenerateTask
 from dbt.task.run import RunTask
 from dbt.task.run_operation import RunOperationTask
 from dbt.task.seed import SeedTask

tests/functional/docs/test_static.py

@@ -1,7 +1,7 @@
 import pytest
 
 from dbt.clients.system import load_file_contents
-from dbt.include.global_project import DOCS_INDEX_FILE_PATH
+from dbt.task.docs import DOCS_INDEX_FILE_PATH
 from dbt.tests.util import run_dbt
 import os
 

tests/unit/test_adapter_factory.py

@@ -3,7 +3,7 @@
 from unittest import mock
 from dbt.adapters.factory import AdapterContainer
 from dbt.adapters.base.plugin import AdapterPlugin
-from dbt.include.global_project import (
+from dbt.adapters.include.global_project import (
     PROJECT_NAME as GLOBAL_PROJECT_NAME,
 )
 

tests/unit/test_docs_generate.py

@@ -2,14 +2,14 @@
 from unittest import mock
 import unittest
 
-from dbt.task import generate
+from dbt.task.docs import generate
 
 
 class GenerateTest(unittest.TestCase):
     def setUp(self):
         self.maxDiff = None
         self.manifest = mock.MagicMock()
-        self.patcher = mock.patch("dbt.task.generate.get_unique_id_mapping")
+        self.patcher = mock.patch("dbt.task.docs.generate.get_unique_id_mapping")
         self.mock_get_unique_id_mapping = self.patcher.start()
 
     def tearDown(self):