Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,19 @@ jobs:
image: [
"test_debian:bullseye",
"test_debian:bookworm",
"test_debian:trixie",
"test_ubuntu:2004",
"test_ubuntu:2204",
"test_ubuntu:2404",
"test_fedora:41"
"test_fedora:41",
"test_fedora:42"
]
cmdopt: [ "-P ./CMakeLists.txt", "." ]
runs-on: ubuntu-latest
container:
image: ghcr.io/cmakelib/${{ matrix.image }}
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Init CMakelib
run: |
git clone "https://github.com/cmakelib/cmakelib.git"
Expand All @@ -40,7 +42,7 @@ jobs:
cmdopt: [ "-P ./CMakeLists.txt", "." ]
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Init CMakelib
run: |
git clone "https://github.com/cmakelib/cmakelib.git"
Expand All @@ -56,7 +58,7 @@ jobs:
cmdopt: [ "-P ./CMakeLists.txt", "." ]
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Init CMakelib
run: |
git clone "https://github.com/cmakelib/cmakelib.git"
Expand Down
1 change: 1 addition & 0 deletions FindCMUTIL.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@ INCLUDE(${CMAKE_CURRENT_LIST_DIR}/system_modules/CMUTIL_TRAIT.cmake)
INCLUDE(${CMAKE_CURRENT_LIST_DIR}/system_modules/CMUTIL_PROPERTY_FILE.cmake)
INCLUDE(${CMAKE_CURRENT_LIST_DIR}/system_modules/CMUTIL_VERSION.cmake)
INCLUDE(${CMAKE_CURRENT_LIST_DIR}/system_modules/CMUTIL_PLATFORM_STRING.cmake)
INCLUDE(${CMAKE_CURRENT_LIST_DIR}/system_modules/CMUTIL_NORMALIZE_GIT_URI.cmake)

12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Provide mixed functionality for other CMake-lib components

List of functionality

- [CMUTIL_NORMALIZE_GIT_URI.cmake] - normalize Git URIs between SSH and HTTP formats
- [CMUTIL_PROPERTY_FILE.cmake] - read properties in form "<key>=<value>" from a file
- [CMUTIL_TRAIT.cmake] - ensure that the given traits are met
- [CMUTIL_VERSION.cmake] - version manipulation
Expand All @@ -21,8 +22,9 @@ Project is licensed under [MIT](LICENSE)



[CMUTIL_PROPERTY_FILE.cmake]: ./system_modules/CMUTIL_PROPERTY_FILE.cmake
[CMUTIL_VERSION.cmake]: ./system_modules/CMUTIL_VERSION.cmake
[CMUTIL_TRAIT.cmake]: ./system_modules/CMUTIL_TRAIT.cmake
[CMLIB]: https://github.com/cmakelib/cmakelib
[buildbadge_github]: https://github.com/cmakelib/cmakelib-component-util/workflows/Tests/badge.svg
[CMUTIL_NORMALIZE_GIT_URI.cmake]: ./system_modules/CMUTIL_NORMALIZE_GIT_URI.cmake
[CMUTIL_PROPERTY_FILE.cmake]: ./system_modules/CMUTIL_PROPERTY_FILE.cmake
[CMUTIL_VERSION.cmake]: ./system_modules/CMUTIL_VERSION.cmake
[CMUTIL_TRAIT.cmake]: ./system_modules/CMUTIL_TRAIT.cmake
[CMLIB]: https://github.com/cmakelib/cmakelib
[buildbadge_github]: https://github.com/cmakelib/cmakelib-component-util/workflows/Tests/badge.svg
179 changes: 179 additions & 0 deletions system_modules/CMUTIL_NORMALIZE_GIT_URI.cmake
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
## Main
#
# Normalize Git URI to HTTP or SSH format compatible with
# all major Git hosting services like Github, Gitlab, Bitbucket, etc.
#
# [Definition]
# Git URIs can be in two main formats:
# SSH format: git@hostname:path/to/repo.git
# HTTP format: https://hostname/path/to/repo.git
#
# This module provides functionality to convert between these formats
# while preserving all path information and handling edge cases like
# port numbers and repositories without .git extension.
#

IF(DEFINED CMUTIL_NORMALIZE_GIT_URI_MODULE)
RETURN()
ENDIF()
SET(CMUTIL_NORMALIZE_GIT_URI_MODULE 1)

FIND_PACKAGE(CMLIB)



##
# Normalize Git URI to specified target format (SSH or HTTP).
#
# Converts Git URIs between SSH and HTTP formats:
# SSH format: git@hostname:path/to/repo.git
# HTTP format: https://hostname/path/to/repo.git
#
# If the input URI is already in the target format, it is returned unchanged.
# Supports complex paths, custom domains, port numbers, and repositories
# without .git extension.
#
# <function>(
# URI <git_uri>
# TARGET_TYPE <SSH|HTTP>
# OUTPUT_VAR <output_variable>
# )
FUNCTION(CMUTIL_NORMALIZE_GIT_URI)
CMLIB_PARSE_ARGUMENTS(
ONE_VALUE
URI
TARGET_TYPE
OUTPUT_VAR
REQUIRED
URI
TARGET_TYPE
OUTPUT_VAR
P_ARGN ${ARGN}
)

SET(output_value)
IF(__TARGET_TYPE STREQUAL "SSH")
_CMUTIL_NORMALIZE_GIT_URI_SSH(
URI "${__URI}"
OUTPUT_VAR _var
)
SET(output_value "${_var}")
ELSEIF(__TARGET_TYPE STREQUAL "HTTP")
_CMUTIL_NORMALIZE_GIT_URI_HTTP(
URI "${__URI}"
OUTPUT_VAR _var
)
SET(output_value "${_var}")
ELSE()
MESSAGE(FATAL_ERROR "Invalid TARGET_TYPE '${__TARGET_TYPE}'")
ENDIF()

SET(${__OUTPUT_VAR} "${output_value}" PARENT_SCOPE)
ENDFUNCTION()



## Helper
#
# Converts HTTP(S) Git URIs to SSH format.
# If URI is already in SSH format, returns it unchanged.
#
# Transformation examples:
# https://github.com/user/repo.git --> git@github.com:user/repo.git
# https://gitlab.com/user/repo.git --> git@gitlab.com:user/repo.git
# git@gitlab.com:user/repo.git --> git@gitlab.com:user/repo.git (unchanged)
#
# <function>(
# URI <uri>
# OUTPUT_VAR <output_variable>
# )
#
FUNCTION(_CMUTIL_NORMALIZE_GIT_URI_SSH)
CMLIB_PARSE_ARGUMENTS(
ONE_VALUE
URI
OUTPUT_VAR
REQUIRED
URI
OUTPUT_VAR
P_ARGN ${ARGN}
)

SET(uri "${__URI}")

STRING(REGEX MATCH "^git@.*" git_ssh_uri "${uri}")
IF(git_ssh_uri)
SET(${__OUTPUT_VAR} "${uri}" PARENT_SCOPE)
RETURN()
ENDIF()

STRING(REGEX MATCH "^https?://" git_http_uri "${uri}")
IF(NOT git_http_uri)
MESSAGE(FATAL_ERROR "URI '${uri}' is not a valid HTTP(S) or git@ Git URI")
ENDIF()

STRING(REGEX MATCH "^https?://([^/]+)/(.+)$" http_match "${uri}")
IF(NOT http_match)
MESSAGE(FATAL_ERROR "URI '${uri}' is not a valid HTTP(S) or git@ Git URI")
ENDIF()

STRING(REGEX REPLACE "^https?://([^/]+)/(.+)$" "\\1" hostname "${uri}")
STRING(REGEX REPLACE "^https?://([^/]+)/(.+)$" "\\2" path "${uri}")

SET(ssh_uri "git@${hostname}:${path}")
SET(${__OUTPUT_VAR} "${ssh_uri}" PARENT_SCOPE)
ENDFUNCTION()



## Helper
#
# Converts SSH Git URIs to HTTPS format.
# If URI is already in HTTP(S) format, returns it unchanged.
#
# Transformation examples:
# git@github.com:user/repo.git --> https://github.com/user/repo.git
# git@gitlab.com:user/repo.git --> https://gitlab.com/user/repo.git
# https://github.com/user/repo.git --> https://github.com/user/repo.git (unchanged)
#
# <function>(
# URI <uri>
# OUTPUT_VAR <output_variable>
# )
#
FUNCTION(_CMUTIL_NORMALIZE_GIT_URI_HTTP)
CMLIB_PARSE_ARGUMENTS(
ONE_VALUE
URI
OUTPUT_VAR
REQUIRED
URI
OUTPUT_VAR
P_ARGN ${ARGN}
)

SET(uri "${__URI}")

STRING(REGEX MATCH "^https?://" git_http_uri "${uri}")
IF(git_http_uri)
SET(${__OUTPUT_VAR} "${uri}" PARENT_SCOPE)
RETURN()
ENDIF()

STRING(REGEX MATCH "^git@.*" git_ssh_uri "${uri}")
IF(NOT git_ssh_uri)
MESSAGE(FATAL_ERROR "URI '${uri}' is not a valid git@ or HTTP(S) Git URI")
ENDIF()

STRING(REGEX MATCH "^git@([^:]+):(.+)$" ssh_match "${uri}")
IF(NOT ssh_match)
MESSAGE(FATAL_ERROR "URI '${uri}' is not a valid git@ or HTTP(S) Git URI")
ENDIF()

STRING(REGEX REPLACE "^git@([^:]+):(.+)$" "\\1" hostname "${uri}")
STRING(REGEX REPLACE "^git@([^:]+):(.+)$" "\\2" path "${uri}")

SET(https_uri "https://${hostname}/${path}")
SET(${__OUTPUT_VAR} "${https_uri}" PARENT_SCOPE)
ENDFUNCTION()

1 change: 1 addition & 0 deletions test/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ INCLUDE("${CMAKE_CURRENT_LIST_DIR}/TEST.cmake")
TEST_RUN("PROPERTY_FILE/")
TEST_RUN("TRAIT/")
TEST_RUN("VERSION/")
TEST_RUN("NORMALIZE_GIT_URI/")
121 changes: 121 additions & 0 deletions test/NORMALIZE_GIT_URI/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
IF(NOT DEFINED CMAKE_SCRIPT_MODE_FILE)
CMAKE_MINIMUM_REQUIRED(VERSION 3.18)
PROJECT(CMUTIL_NORMALIZE_GIT_URI_TEST)
ENDIF()

LIST(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/../../")

INCLUDE("${CMAKE_CURRENT_LIST_DIR}/../TEST.cmake")

FIND_PACKAGE(CMUTIL)



FUNCTION(TEST_SSH_TARGET_TYPE)
CMUTIL_NORMALIZE_GIT_URI(
URI "https://github.com/username/repository.git"
TARGET_TYPE "SSH"
OUTPUT_VAR result
)
TEST_VAR_EQUALS_LITERAL(result "git@github.com:username/repository.git")

CMUTIL_NORMALIZE_GIT_URI(
URI "https://gitlab.com/user/repo.git"
TARGET_TYPE "SSH"
OUTPUT_VAR result
)
TEST_VAR_EQUALS_LITERAL(result "git@gitlab.com:user/repo.git")

CMUTIL_NORMALIZE_GIT_URI(
URI "http://example.com/path/to/repo.git"
TARGET_TYPE "SSH"
OUTPUT_VAR result
)
TEST_VAR_EQUALS_LITERAL(result "git@example.com:path/to/repo.git")

CMUTIL_NORMALIZE_GIT_URI(
URI "git@github.com:user/repo.git"
TARGET_TYPE "SSH"
OUTPUT_VAR result
)
TEST_VAR_EQUALS_LITERAL(result "git@github.com:user/repo.git")

CMUTIL_NORMALIZE_GIT_URI(
URI "https://gitlab.example.com/group/subgroup/project.git"
TARGET_TYPE "SSH"
OUTPUT_VAR result
)
TEST_VAR_EQUALS_LITERAL(result "git@gitlab.example.com:group/subgroup/project.git")

CMUTIL_NORMALIZE_GIT_URI(
URI "https://github.com/user/repo"
TARGET_TYPE "SSH"
OUTPUT_VAR result
)
TEST_VAR_EQUALS_LITERAL(result "git@github.com:user/repo")

CMUTIL_NORMALIZE_GIT_URI(
URI "https://git.example.com:8080/user/repo.git"
TARGET_TYPE "SSH"
OUTPUT_VAR result
)
TEST_VAR_EQUALS_LITERAL(result "git@git.example.com:8080:user/repo.git")
ENDFUNCTION()



FUNCTION(TEST_HTTP_TARGET_TYPE)
CMUTIL_NORMALIZE_GIT_URI(
URI "git@github.com:username/repository.git"
TARGET_TYPE "HTTP"
OUTPUT_VAR result
)
TEST_VAR_EQUALS_LITERAL(result "https://github.com/username/repository.git")

CMUTIL_NORMALIZE_GIT_URI(
URI "git@gitlab.com:user/repo.git"
TARGET_TYPE "HTTP"
OUTPUT_VAR result
)
TEST_VAR_EQUALS_LITERAL(result "https://gitlab.com/user/repo.git")

CMUTIL_NORMALIZE_GIT_URI(
URI "git@example.com:path/to/repo.git"
TARGET_TYPE "HTTP"
OUTPUT_VAR result
)
TEST_VAR_EQUALS_LITERAL(result "https://example.com/path/to/repo.git")

CMUTIL_NORMALIZE_GIT_URI(
URI "https://github.com/user/repo.git"
TARGET_TYPE "HTTP"
OUTPUT_VAR result
)
TEST_VAR_EQUALS_LITERAL(result "https://github.com/user/repo.git")

CMUTIL_NORMALIZE_GIT_URI(
URI "http://example.com/user/repo.git"
TARGET_TYPE "HTTP"
OUTPUT_VAR result
)
TEST_VAR_EQUALS_LITERAL(result "http://example.com/user/repo.git")

CMUTIL_NORMALIZE_GIT_URI(
URI "git@gitlab.example.com:group/subgroup/project.git"
TARGET_TYPE "HTTP"
OUTPUT_VAR result
)
TEST_VAR_EQUALS_LITERAL(result "https://gitlab.example.com/group/subgroup/project.git")

CMUTIL_NORMALIZE_GIT_URI(
URI "git@github.com:user/repo"
TARGET_TYPE "HTTP"
OUTPUT_VAR result
)
TEST_VAR_EQUALS_LITERAL(result "https://github.com/user/repo")
ENDFUNCTION()

TEST_SSH_TARGET_TYPE()
TEST_HTTP_TARGET_TYPE()

TEST_RUN("fail/")
12 changes: 12 additions & 0 deletions test/NORMALIZE_GIT_URI/fail/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
IF(NOT DEFINED CMAKE_SCRIPT_MODE_FILE)
CMAKE_MINIMUM_REQUIRED(VERSION 3.18)
PROJECT(CMUTIL_NORMALIZE_GIT_URI_FAIL_TEST)
ENDIF()

LIST(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/../../../")

INCLUDE("${CMAKE_CURRENT_LIST_DIR}/../../TEST.cmake")

TEST_INVALID_CMAKE_RUN("invalid_target_type/" "Invalid TARGET_TYPE")
TEST_INVALID_CMAKE_RUN("invalid_http_uri/" "is not a valid HTTP\\(S\\) or git@ Git URI")
TEST_INVALID_CMAKE_RUN("invalid_ssh_uri/" "is not a valid git@ or HTTP\\(S\\) Git URI")
Loading
Loading