add conan package reference

Author: amhellmund

conan/recipes/googletest/conanfile.py

@@ -1,27 +1,23 @@
-from conan import ConanFile
+import os
+
 from conan.errors import ConanInvalidConfiguration
 from conan.tools.build import check_min_cppstd
 from conan.tools.cmake import CMake, CMakeToolchain, cmake_layout
-from conan.tools.files import (
-    apply_conandata_patches,
-    copy,
-    export_conandata_patches,
-    get,
-    replace_in_file,
-    rm,
-    rmdir,
-)
+from conan.tools.files import (apply_conandata_patches, copy,
+                               export_conandata_patches, get, replace_in_file,
+                               rm, rmdir)
 from conan.tools.microsoft import is_msvc_static_runtime, msvc_runtime_flag
 from conan.tools.scm import Version
-import os
+
+from conan import ConanFile
 
 required_conan_version = ">=1.54.0"
 
 
 class GTestConan(ConanFile):
     name = "gtest"
-    user = "cppdev"
-    channel = "official"
+    user = "official"
+    channel = "cppdev"
     description = "Google's C++ test framework"
     license = "BSD-3-Clause"
     url = "https://github.com/conan-io/conan-center-index"

conan/recipes/llvm/conanfile.py

@@ -1,15 +1,16 @@
 import os
 
-from conan import ConanFile
+from conan.tools.cmake import CMake, CMakeToolchain, cmake_layout
 from conan.tools.files import collect_libs, copy, get
-from conan.tools.cmake import CMakeToolchain, CMake, cmake_layout
 from conan.tools.files.symlinks import absolute_to_relative_symlinks
 
+from conan import ConanFile
+
 
 class LlvmRecipe(ConanFile):
     name = "llvm"
-    user = "cppdev"
-    channel = "official"
+    user = "official"
+    channel = "cppdev"
     major = 19
     minor = 1
     patch = 0

src/cpp_dev/conan/commands.py

@@ -8,6 +8,7 @@
 from pathlib import Path
 
 from cpp_dev.common.process import run_command
+from cpp_dev.common.types import SemanticVersion
 from cpp_dev.common.utils import updated_env
 from cpp_dev.conan.config import get_conan_config_source_dir, get_remotes
 
@@ -17,6 +18,7 @@
 
 
 CONAN_HOME_ENV_VAR = "CONAN_HOME"
+CONAN_REMOTE = "cpd"
 
 
 def initialize_conan(conan_home: Path) -> None:
@@ -27,6 +29,12 @@ def initialize_conan(conan_home: Path) -> None:
         _set_conan_default_user_and_password(conan_config_dir)
 
 
+def get_available_versions(conan_home: Path, repository: str, name: str) -> list[SemanticVersion]:
+    """Retrieve available versions for a package represented by repository (aka. Conan user) and name."""
+    with _conan_env(conan_home):
+        versions = _list_conan_versions(repository, name)
+
+
 ###############################################################################
 # Implementation                                                            ###
 ###############################################################################
@@ -51,12 +59,29 @@ def _install_conan_config(conan_config_dir: Path) -> None:
 def _set_conan_default_user_and_password(conan_config_dir: Path) -> None:
     conan_remotes = get_remotes(conan_config_dir)
     for remote in conan_remotes.remotes:
-        run_command(
-            "conan",
-            "remote",
-            "login",
-            remote.name,
-            _DEFAULT_CONAN_USER,
-            "-p",
-            _DEFAULT_CONAN_USER_PWD,
-        )
+        _command_wrapper_conan_remote_login(remote.name, _DEFAULT_CONAN_USER, _DEFAULT_CONAN_USER_PWD)
+
+def _command_wrapper_conan_remote_login(remote: str, user: str, password: str) -> None:
+    run_command(
+        "conan",
+        "remote",
+        "login",
+        remote,
+        user,
+        "-p",
+        password,
+    )
+
+
+def _list_conan_versions(repository: str, name: str) -> list[SemanticVersion]:
+    stdout, stderr = run_command("conan", "list", "--json", f"")
+
+
+def _command_wrapper_conan_list(remote: str, name: str) -> list[str]:
+    stdout, stderr = run_command(
+        "conan",
+        "list",
+        "--json",
+        f"--remote={remote}",
+        f"{repository}/{name}",
+    )

src/cpp_dev/conan/config/remotes.json

@@ -1,10 +1,5 @@
 {
     "remotes": [
-        {
-            "name": "cpd_official",
-            "url": "http://localhost:8081/artifactory/api/conan/cpd_official",
-            "verify_ssl": false
-        },
         {
             "name": "cpd",
             "url": "http://localhost:8081/artifactory/api/conan/cpd",

src/cpp_dev/conan/types.py

@@ -0,0 +1,37 @@
+# Copyright (c) 2024 Andi Hellmund. All rights reserved.
+
+# This work is licensed under the terms of the BSD-3-Clause license.
+# For a copy, see <https://opensource.org/license/bsd-3-clause>.
+
+import re
+
+from cpp_dev.common.types import SemanticVersion
+
+###############################################################################
+# Public API                                                                ###
+###############################################################################
+
+ 
+class ConanPackageReference:
+    CONAN_REFERENCE_PATTERN = r"(?P<name>[a-zA-Z0-9_]+)/(?P<version>\d+\.\d+\.\d+)@(?P<user>[a-zA-Z0-9_]+)/(?P<channel>[a-zA-Z0-9_]+)"
+
+    def __init__(self, ref_str: str) -> None:
+        """
+        Initialize a ConanPackageReference object.
+
+        This method parses a Conan package reference string and extracts its components.
+        It also validates the semantic version format. A Conan package reference has the format:
+
+            name/version@user/channel
+        """
+        match = re.match(self.CONAN_REFERENCE_PATTERN, ref_str)
+        if not match:
+            raise ValueError(f"Invalid Conan package reference: {ref_str}")
+
+        self.name = match.group('name')
+        self.version = SemanticVersion(match.group('version'))
+        self.user = match.group('user')
+        self.channel = match.group('channel')
+
+    def __str__(self) -> str:
+        return f"{self.name}/{self.version}@{self.user}/{self.channel}"

src/cpp_dev/project/management.py

@@ -0,0 +1,114 @@
+# Copyright (c) 2024 Andi Hellmund. All rights reserved.
+
+# This work is licensed under the terms of the BSD-3-Clause license.
+# For a copy, see <https://opensource.org/license/bsd-3-clause>.
+
+
+from pathlib import Path
+from textwrap import dedent
+
+from cpp_dev.project.dependency.types import PackageDependency
+from cpp_dev.project.lockfile import create_initial_lock_file
+
+from .config import create_project_config
+from .constants import compose_include_file, compose_source_file
+from .types import DependencyType, ProjectConfig
+
+###############################################################################
+# Public API                                                                ###
+###############################################################################
+
+
+def setup_project(
+    project_config: ProjectConfig,
+    parent_dir: Path | None = None,
+) -> Path:
+    """Create a new cpp-dev project in the specified parent directory.
+
+    The path to the new project directory is returned.
+    """
+    project_dir = _validate_project_dir(parent_dir, project_config.name)
+    create_project_config(project_dir, project_config)
+    create_initial_lock_file(project_dir)
+    _add_default_cpd_dependencies(project_dir)
+    _create_project_files(project_dir, project_config.name)
+    return project_dir
+
+
+def add_package_dependency(project_dir: Path, deps: list[PackageDependency], dep_type: DependencyType) -> None:
+    """Add package dependencies to the project for the given type."""
+
+
+###############################################################################
+# Implementation                                                            ###
+###############################################################################
+
+
+def _validate_project_dir(parent_dir: Path | None, name: str) -> Path:
+    """Check and validate if the project directory does not yet exist."""
+    if parent_dir is None:
+        parent_dir = Path.cwd()
+    project_dir = parent_dir / name
+    if project_dir.exists():
+        raise ValueError(f"Project directory {project_dir} already exists.")
+    project_dir.mkdir(parents=True)
+    return project_dir
+
+
+def _add_default_cpd_dependencies(project_dir: Path) -> None:
+    add_package_dependency(project_dir, [PackageDependency("llvm"), PackageDependency("gtest")], "cpd")
+
+
+def _create_project_files(project_dir: Path, name: str) -> None:
+    """Create the necessary project files for the cpp-dev package."""
+    _create_library_include_file(project_dir, name)
+    _create_library_source_file(project_dir, name)
+    _create_library_test_file(project_dir, name)
+
+
+def _create_library_include_file(project_dir: Path, name: str) -> None:
+    include_file = compose_include_file(project_dir, name, f"{name}.hpp")
+    include_file.parent.mkdir(parents=True)
+    include_file.write_text(
+        dedent(
+            f"""\
+            #pragma once
+
+            namespace {name} {{
+                int api();
+            }}
+            """,
+        ),
+    )
+
+
+def _create_library_source_file(project_dir: Path, name: str) -> None:
+    source_file = compose_source_file(project_dir, f"{name}.cpp")
+    source_file.parent.mkdir(parents=True)
+    source_file.write_text(
+        dedent(
+            f"""\
+            #include "{name}/{name}.hpp"
+
+            int {name}::api() {{
+                return 42;
+            }}
+            """,
+        ),
+    )
+
+
+def _create_library_test_file(project_dir: Path, name: str) -> None:
+    test_file = compose_source_file(project_dir, f"{name}.test.cpp")
+    test_file.write_text(
+        dedent(
+            f"""\
+            #include <gtest/gtest.h>
+            #include "{name}/{name}.hpp"
+
+            TEST({name}, api) {{
+                EXPECT_EQ({name}::api(), 42);
+            }}
+            """,
+        ),
+    )

src/tests/cpp_dev/conan/test_types.py

@@ -0,0 +1,22 @@
+import pytest
+
+from cpp_dev.common.types import SemanticVersion
+from cpp_dev.conan.types import ConanPackageReference
+
+
+@pytest.mark.parametrize("invalid_ref", [
+    "",
+    "invalid_reference",
+    "mypackage/@myuser/stable",
+])
+def test_conan_package_reference_invalid(invalid_ref):
+    with pytest.raises(ValueError, match="Invalid Conan package reference:"):
+        ConanPackageReference(invalid_ref)
+
+def test_conan_package_reference_valid() -> None:
+    package_ref = ConanPackageReference("name/1.2.3@user/channel")
+    
+    assert package_ref.name == "name"
+    assert package_ref.version == SemanticVersion("1.2.3")
+    assert package_ref.user == "user"
+    assert package_ref.channel == "channel"

src/tests/cpp_dev/project/test_management.py

@@ -0,0 +1,49 @@
+# Copyright (c) 2024 Andi Hellmund. All rights reserved.
+
+# This work is licensed under the terms of the BSD-3-Clause license.
+# For a copy, see <https://opensource.org/license/bsd-3-clause>.
+
+
+from pathlib import Path
+
+from cpp_dev.project.config import load_project_config
+from cpp_dev.project.constants import compose_project_config_file, compose_project_lock_file
+from cpp_dev.project.lockfile import load_lock_file
+from cpp_dev.project.management import setup_project
+from cpp_dev.project.types import ProjectConfig, SemanticVersion
+
+
+def test_setup_project(tmp_path: Path) -> None:
+    project_config = ProjectConfig(
+        name="test_package",
+        version=SemanticVersion("1.0.0"),
+        std="c++17",
+        author="author",
+        license="license",
+        description="description",
+        dependencies=[],
+        dev_dependencies=[],
+        cpd_dependencies=[],
+    )
+
+    project_dir = setup_project(project_config, parent_dir=tmp_path)
+
+    assert project_dir.exists()
+    assert project_dir == tmp_path / project_config.name
+
+    assert compose_project_config_file(project_dir).exists()
+
+    config = load_project_config(project_dir)
+    assert config == project_config
+
+    assert len(config.dependencies) == 0
+    assert len(config.dev_dependencies) == 0
+    assert len(config.cpd_dependencies) == 0
+
+    assert compose_project_lock_file(project_dir).exists()
+    locked_dependencies = load_lock_file(project_dir)
+    assert len(locked_dependencies.packages) == 0
+
+    assert (project_dir / "include" / project_config.name / f"{project_config.name}.hpp").exists()
+    assert (project_dir / "src" / f"{project_config.name}.cpp").exists()
+    assert (project_dir / "src" / f"{project_config.name}.test.cpp").exists()