From c38335f06194444230f557aa14f2963753046a46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Olivier=20Gauth=C3=A9?= Date: Wed, 18 Dec 2024 18:32:09 +0100 Subject: [PATCH] update Skeleton --- .github/workflows/Documentation.yml | 3 +- .pre-commit-config.yaml | 9 ++-- Project.toml | 9 ---- README.md | 8 +++- examples/README.jl | 10 ++++- test/Project.toml | 11 +++++ test/basics/test_basics.jl | 6 +++ test/runtests.jl | 65 +++++++++++++++++++++++++---- test/test_aqua.jl | 3 -- 9 files changed, 97 insertions(+), 27 deletions(-) create mode 100644 test/Project.toml create mode 100644 test/basics/test_basics.jl diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml index 75c7be5..01a7f7a 100644 --- a/.github/workflows/Documentation.yml +++ b/.github/workflows/Documentation.yml @@ -19,4 +19,5 @@ jobs: uses: "ITensor/ITensorActions/.github/workflows/Documentation.yml@main" with: localregistry: https://github.com/ITensor/ITensorRegistry.git - secrets: "inherit" + secrets: + CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index bff1fb7..80c74e2 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,13 +1,14 @@ repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.5.0 + rev: v5.0.0 hooks: - id: check-merge-conflict - id: check-toml - id: check-yaml - id: end-of-file-fixer exclude_types: [markdown] # incompatible with Literate.jl -- repo: https://github.com/qiaojunfeng/pre-commit-julia-format - rev: v0.2.0 + +- repo: "https://github.com/domluna/JuliaFormatter.jl" + rev: v2.0.0 hooks: - - id: julia-format + - id: "julia-formatter" diff --git a/Project.toml b/Project.toml index 3de3ed6..1d82813 100644 --- a/Project.toml +++ b/Project.toml @@ -4,13 +4,4 @@ authors = ["ITensor developers and contributors"] version = "0.1.0" [compat] -Aqua = "0.8.9" -Test = "1.10" julia = "1.10" - -[extras] -Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595" -Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" - -[targets] -test = ["Aqua", "Test"] diff --git a/README.md b/README.md index 1ba43b1..a19a440 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/FusionTensors.jl/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ITensor.github.io/FusionTensors.jl/dev/) -[![Build Status](https://github.com/ITensor/FusionTensors.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ITensor/FusionTensors.jl/actions/workflows/CI.yml?query=branch%3Amain) +[![Build Status](https://github.com/ITensor/FusionTensors.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/FusionTensors.jl/actions/workflows/Tests.yml?query=branch%3Amain) [![Coverage](https://codecov.io/gh/ITensor/FusionTensors.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/FusionTensors.jl) [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl) @@ -17,6 +17,12 @@ julia> using Pkg: Pkg julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry") ``` +or: +```julia +julia> Pkg.Registry.add(url="git@github.com:ITensor/ITensorRegistry.git") +``` +if you want to use SSH credentials, which can make it so you don't have to enter your Github ursername and password when registering packages. + Then, the package can be added as usual through the package manager: ```julia diff --git a/examples/README.jl b/examples/README.jl index 165eaf9..3273af4 100644 --- a/examples/README.jl +++ b/examples/README.jl @@ -2,7 +2,7 @@ # # [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/FusionTensors.jl/stable/) # [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ITensor.github.io/FusionTensors.jl/dev/) -# [![Build Status](https://github.com/ITensor/FusionTensors.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ITensor/FusionTensors.jl/actions/workflows/CI.yml?query=branch%3Amain) +# [![Build Status](https://github.com/ITensor/FusionTensors.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/FusionTensors.jl/actions/workflows/Tests.yml?query=branch%3Amain) # [![Coverage](https://codecov.io/gh/ITensor/FusionTensors.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/FusionTensors.jl) # [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) # [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl) @@ -19,6 +19,14 @@ julia> using Pkg: Pkg julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry") ``` =# +# or: +#= +```julia +julia> Pkg.Registry.add(url="git@github.com:ITensor/ITensorRegistry.git") +``` +=# +# if you want to use SSH credentials, which can make it so you don't have to enter your Github ursername and password when registering packages. + # Then, the package can be added as usual through the package manager: #= diff --git a/test/Project.toml b/test/Project.toml new file mode 100644 index 0000000..e9c291e --- /dev/null +++ b/test/Project.toml @@ -0,0 +1,11 @@ +[deps] +Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595" +SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f" +Suppressor = "fd094767-a336-5f1f-9728-57cf17d0bbfb" +Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" + +[compat] +Aqua = "0.8.9" +SafeTestsets = "0.1" +Suppressor = "0.2" +Test = "1.10" diff --git a/test/basics/test_basics.jl b/test/basics/test_basics.jl new file mode 100644 index 0000000..a6d9b13 --- /dev/null +++ b/test/basics/test_basics.jl @@ -0,0 +1,6 @@ +using FusionTensors: FusionTensors +using Test: @test, @testset + +@testset "FusionTensors" begin + # Tests go here. +end diff --git a/test/runtests.jl b/test/runtests.jl index 3c16373..bd97441 100644 --- a/test/runtests.jl +++ b/test/runtests.jl @@ -1,12 +1,61 @@ -@eval module $(gensym()) -using Test: @testset +using SafeTestsets: @safetestset +using Suppressor: Suppressor -@testset "FusionTensors.jl" begin - filenames = filter(readdir(@__DIR__)) do f - startswith("test_")(f) && endswith(".jl")(f) +# check for filtered groups +# either via `--group=ALL` or through ENV["GROUP"] +const pat = r"(?:--group=)(\w+)" +arg_id = findfirst(contains(pat), ARGS) +const GROUP = uppercase( + if isnothing(arg_id) + get(ENV, "GROUP", "ALL") + else + only(match(pat, ARGS[arg_id]).captures) + end, +) + +"match files of the form `test_*.jl`, but exclude `*setup*.jl`" +istestfile(fn) = + endswith(fn, ".jl") && startswith(basename(fn), "test_") && !contains(fn, "setup") +"match files of the form `*.jl`, but exclude `*_notest.jl` and `*setup*.jl`" +isexamplefile(fn) = + endswith(fn, ".jl") && !endswith(fn, "_notest.jl") && !contains(fn, "setup") + +@time begin + # tests in groups based on folder structure + for testgroup in filter(isdir, readdir(@__DIR__)) + if GROUP == "ALL" || GROUP == uppercase(testgroup) + for file in filter(istestfile, readdir(joinpath(@__DIR__, testgroup); join=true)) + @eval @safetestset $file begin + include($file) + end + end + end + end + + # single files in top folder + for file in filter(istestfile, readdir(@__DIR__)) + (file == basename(@__FILE__)) && continue # exclude this file to avoid infinite recursion + @eval @safetestset $file begin + include($file) + end end - @testset "Test $filename" for filename in filenames - include(filename) + + # test examples + examplepath = joinpath(@__DIR__, "..", "examples") + for (root, _, files) in walkdir(examplepath) + contains(chopprefix(root, @__DIR__), "setup") && continue + for file in filter(isexamplefile, files) + filename = joinpath(root, file) + @eval begin + @safetestset $file begin + $(Expr( + :macrocall, + GlobalRef(Suppressor, Symbol("@suppress")), + LineNumberNode(@__LINE__, @__FILE__), + :(include($filename)), + )) + end + end + end end end -end diff --git a/test/test_aqua.jl b/test/test_aqua.jl index 3ddddb1..ba30be2 100644 --- a/test/test_aqua.jl +++ b/test/test_aqua.jl @@ -1,4 +1,3 @@ -@eval module $(gensym()) using FusionTensors: FusionTensors using Aqua: Aqua using Test: @testset @@ -6,5 +5,3 @@ using Test: @testset @testset "Code quality (Aqua.jl)" begin Aqua.test_all(FusionTensors) end - -end