-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add script, which set QED dependencies of QED dependencies to dev dep…
…ending on the target branch - if the target branch is main, use released QED dependencies - if the target branch is not main, use the dev branch versions of the QED dependencies
- Loading branch information
1 parent
7588afe
commit 8ecbf6a
Showing
5 changed files
with
207 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| module getTargetBranch | ||
|
|
||
| using HTTP | ||
| using JSON | ||
|
|
||
| """ | ||
| get_target_branch()::AbstractString | ||
| Returns the name of the target branch of the pull request. The function is required for our special | ||
| setup where we mirror a PR from GitHub to GitLab CI. No merge request will be open on GitLab. | ||
| Instead, a feature branch will be created and the commit will be pushed. As a result, we lose | ||
| information about the original PR. So we need to use the GitHub Rest API to get the information | ||
| depending on the repository name and PR number. | ||
| """ | ||
| function get_target_branch()::AbstractString | ||
| # GitLab CI provides the environemnt variable with the following pattern | ||
| # # pr-<PR number>/<repo owner of the source branch>/<project name>/<source branch name> | ||
| # e.g. pr-41/SimeonEhrig/QED.jl/setDevDepDeps | ||
| if !haskey(ENV, "CI_COMMIT_REF_NAME") | ||
| error("Environment variable CI_COMMIT_REF_NAME is not set.") | ||
| end | ||
|
|
||
| splited_commit_ref_name = split(ENV["CI_COMMIT_REF_NAME"], "/") | ||
|
|
||
| if (!startswith(splited_commit_ref_name[1], "pr-")) | ||
| error("CI_COMMIT_REF_NAME does not start with pr-") | ||
| end | ||
|
|
||
| # parse to Int only to check if it is a number | ||
| pr_number = parse(Int, splited_commit_ref_name[1][(length("pr-") + 1):end]) | ||
| if (pr_number <= 0) | ||
| error( | ||
| "a PR number always needs to be a positiv integer number bigger than 0: $pr_number", | ||
| ) | ||
| end | ||
|
|
||
| repository_name = splited_commit_ref_name[3] | ||
|
|
||
| try | ||
| headers = ( | ||
| ("Accept", "application/vnd.github+json"), | ||
| ("X-GitHub-Api-Version", "2022-11-28"), | ||
| ) | ||
| # in all cases, we assume that the PR targets the repositories in QEDjl-project | ||
| # there is no environment variable with the information, if the target repository is | ||
| # the upstream repository or a fork. | ||
| url = "https://api.github.com/repos/QEDjl-project/$repository_name/pulls/$pr_number" | ||
| response = HTTP.get(url, headers) | ||
| response_text = String(response.body) | ||
| repository_data = JSON.parse(response_text) | ||
| return repository_data["base"]["ref"] | ||
| catch e | ||
| # if for unknown reason, the PR does not exist, use fallback the dev branch | ||
| if isa(e, HTTP.Exceptions.StatusError) && e.status == 404 | ||
| return "dev" | ||
| else | ||
| # Only the HTML code 404, page does not exist is handled. All other error will abort | ||
| # the script. | ||
| throw(e) | ||
| end | ||
| end | ||
|
|
||
| return "dev" | ||
| end | ||
|
|
||
| if abspath(PROGRAM_FILE) == @__FILE__ | ||
| target_branch = get_target_branch() | ||
| println(target_branch) | ||
| end | ||
|
|
||
| end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| """ | ||
| The script sets all QED dependencies of QED dependencies to the version of the current | ||
| development branch. For our example we use the project QEDprocess which has a dependency | ||
| to QEDfields and QEDfields has a dependency to QEDcore (I haven't checked if this is the | ||
| case, it's just hypothetical). If we install the dev-branch version of QEDfields, the last | ||
| registered version of QEDcore is still installed. If QEDfields uses a function which only | ||
| exist in dev branch of QEDcore and is not released yet, the integration test will fail. | ||
| The script needs to be executed the project space, which should be modified. | ||
| """ | ||
|
|
||
| using Pkg | ||
|
|
||
| # TODO(SimeonEhrig): is copied from integTestGen.jl | ||
| """ | ||
| _match_package_filter( | ||
| package_filter::Union{<:AbstractString,Regex}, | ||
| package::AbstractString | ||
| )::Bool | ||
| Check if `package_filter` contains `package`. Wrapper function for `contains()` and `in()`. | ||
| # Returns | ||
| - `true` if it matches. | ||
| """ | ||
| function _match_package_filter( | ||
| package_filter::Union{<:AbstractString,Regex}, package::AbstractString | ||
| )::Bool | ||
| return contains(package, package_filter) | ||
| end | ||
|
|
||
| """ | ||
| _match_package_filter( | ||
| package_filter::AbstractVector{<:AbstractString}, | ||
| package::AbstractString | ||
| )::Bool | ||
| """ | ||
| function _match_package_filter( | ||
| package_filter::AbstractVector{<:AbstractString}, package::AbstractString | ||
| )::Bool | ||
| return package in package_filter | ||
| end | ||
|
|
||
| """ | ||
| get_filtered_dependencies( | ||
| name_filter::Union{<:AbstractString,Regex}=r".*", | ||
| project_source=Pkg.dependencies() | ||
| )::AbstractVector{Pkg.API.PackageInfo} | ||
| Takes the project_dependencies and filter it by the name_filter. Removes also the UUID as | ||
| dict key. | ||
| # Returns | ||
| - `Vector` of filtered dependencies. | ||
| """ | ||
| function get_filtered_dependencies( | ||
| name_filter::Union{<:AbstractString,Regex}=r".*", | ||
| project_dependencies=Pkg.dependencies(), | ||
| )::AbstractVector{Pkg.API.PackageInfo} | ||
| deps = Vector{Pkg.API.PackageInfo}(undef, 0) | ||
| for (uuid, dep) in project_dependencies | ||
| if _match_package_filter(name_filter, dep.name) | ||
| push!(deps, dep) | ||
| end | ||
| end | ||
| return deps | ||
| end | ||
|
|
||
| """ | ||
| set_dev_dependencies( | ||
| dependencies::AbstractVector{Pkg.API.PackageInfo}, | ||
| custom_urls::AbstractDict{String,String}=Dict{String,String}(), | ||
| ) | ||
| Set all dependencies to the development version, if they are not already development versions. | ||
| The dict custom_urls takes as key a dependency name and a URL as value. If a dependency is in | ||
| custom_urls, it will use the URL as development version. If the dependency does not exist in | ||
| custom_urls, it will set the URL https://github.com/QEDjl-project/<dependency_name>.jl | ||
| """ | ||
| function set_dev_dependencies( | ||
| dependencies::AbstractVector{Pkg.API.PackageInfo}, | ||
| custom_urls::AbstractDict{String,String}=Dict{String,String}(), | ||
| ) | ||
| for dep in dependencies | ||
| # if tree_hash is nothing, it is already a dev version | ||
| if !isnothing(dep.tree_hash) | ||
| if haskey(custom_urls, dep.name) | ||
| Pkg.develop(; url=custom_urls[dep.name]) | ||
| else | ||
| Pkg.develop(; url="https://github.com/QEDjl-project/$(dep.name).jl") | ||
| end | ||
| end | ||
| end | ||
| end | ||
|
|
||
| if abspath(PROGRAM_FILE) == @__FILE__ | ||
| deps = get_filtered_dependencies(r"^QED*") | ||
| set_dev_dependencies(deps) | ||
| end |