split out the ECC tests (#536)

Author: Krastanov

.buildkite/pipeline.yml

@@ -3,7 +3,7 @@ env:
   JULIA_NUM_THREADS: auto
   PYTHON: ""
   PYCALL_DEBUG_BUILD: yes
-  
+
 steps:
   - label: "Package Tests"
     plugins:
@@ -33,7 +33,7 @@ steps:
       - julia --project='~' -e '
         using Pkg;
         pkg"dev .";'
-  - label: "Slow Tests"
+  - label: "ECC Tests"
     plugins:
       - JuliaCI/julia#v1:
           version: "1"
@@ -42,7 +42,7 @@ steps:
       - JuliaCI/julia-coverage#v1:
           codecov: true
     env:
-      SLOW_TEST: true
+      ECC_TEST: true
     command:
       - echo "Julia depot path $${JULIA_DEPOT_PATH}"
       - julia --project='~' -e '

test/runtests.jl

@@ -26,10 +26,10 @@ testfilter = ti -> begin
         return :jet in ti.tags
     end
 
-    if get(ENV, "SLOW_TEST", "") != "true"
-        push!(exclude, :slow)
+    if get(ENV, "ECC_TEST", "") != "true"
+        push!(exclude, :ecc)
     else
-        return :slow in ti.tags
+        return :ecc in ti.tags
     end
 
     if get(ENV, "GPU_TESTS", "") != "true"

test/test_ecc.jl

@@ -1,4 +1,4 @@
-@testitem "ECC" begin
+@testitem "ECC" tags=[:ecc] begin
     using QuantumClifford.ECC
     using QuantumClifford.ECC: AbstractECC
 

test/test_ecc_2bga.jl

@@ -1,4 +1,4 @@
-@testitem "ECC 2BGA" begin
+@testitem "ECC 2BGA" tags=[:ecc] begin
     using Hecke
     using JuMP
     using HiGHS

test/test_ecc_bch.jl

@@ -1,12 +1,12 @@
-@testitem "ECC BCH" begin
+@testitem "ECC BCH" tags=[:ecc] begin
     using LinearAlgebra
     using QuantumClifford.ECC
     using QuantumClifford.ECC: AbstractECC, BCH, generator_polynomial
     using Nemo: ZZ, residue_ring, matrix, finite_field, GF, minpoly, coeff, lcm, FqPolyRingElem, FqFieldElem, is_zero, degree, defining_polynomial, is_irreducible
-    using QuantumClifford.ECC.QECCore: code_k, code_n, distance, rate 
+    using QuantumClifford.ECC.QECCore: code_k, code_n, distance, rate
 
     """
-    - To prove that `t`-bit error correcting BCH code indeed has minimum distance of at least `2 * t + 1`, it is shown that no `2 * t` or fewer columns of its binary parity check matrix `H` sum to zero. A formal mathematical proof can be found on pages 168 and 169 of Ch6 of Error Control Coding by Lin, Shu and Costello, Daniel. 
+    - To prove that `t`-bit error correcting BCH code indeed has minimum distance of at least `2 * t + 1`, it is shown that no `2 * t` or fewer columns of its binary parity check matrix `H` sum to zero. A formal mathematical proof can be found on pages 168 and 169 of Ch6 of Error Control Coding by Lin, Shu and Costello, Daniel.
     - The parameter `2 * t + 1` is usually called the designed distance of the `t`-bit error correcting BCH code.
     """
     function check_designed_distance(matrix, t)
@@ -37,7 +37,7 @@
                 @test code_k(BCH(m, t)) == n - degree(generator_polynomial(BCH(m, t)))
                 # BCH code is cyclic as its generator polynomial, `g(x)` divides `xⁿ - 1`, so `mod (xⁿ - 1, g(x))` = 0.
                 gx = generator_polynomial(BCH(m, t))
-                GF2x, x = GF(2)["x"] 
+                GF2x, x = GF(2)["x"]
                 @test mod(x ^ n - 1, gx) == 0
             end
         end
@@ -61,12 +61,12 @@
         @test generator_polynomial(BCH(4, 2)) == x ^ 8 + x ^ 7 +  x ^ 6 +  x ^ 4 + 1
         @test generator_polynomial(BCH(4, 3)) == x ^ 10 + x ^ 8 +  x ^ 5 +  x ^ 4 +  x ^ 2 + x + 1
 
-        # Nemo.jl uses [Conway polynomial](https://en.wikipedia.org/wiki/Conway_polynomial_(finite_fields)), a standard way to represent the primitive polynomial for finite Galois fields `GF(pᵐ)` of degree `m`, where `p` is a prime number. 
+        # Nemo.jl uses [Conway polynomial](https://en.wikipedia.org/wiki/Conway_polynomial_(finite_fields)), a standard way to represent the primitive polynomial for finite Galois fields `GF(pᵐ)` of degree `m`, where `p` is a prime number.
         # The `GF(2⁶)`'s Conway polynomial is `p(z) = z⁶ + z⁴ + z³ + z + 1`. In contrast, the polynomial given in https://web.ntpu.edu.tw/~yshan/BCH_code.pdf is `p(z) = z⁶ + z + 1`. Because both polynomials are irreducible, they are also primitive polynomials for `GF(2⁶)`.
 
         test_cases = [(6, 1), (6, 2), (6, 3), (6, 4), (6, 5), (6, 6), (6, 7), (6, 10), (6, 11), (6, 13), (6, 15)]
         @test defining_polynomial(GF2x, GF2⁶) == x ^ 6 + x ^ 4 + x ^ 3 + x + 1
-        @test is_irreducible(defining_polynomial(GF2x, GF2⁶)) == true    
+        @test is_irreducible(defining_polynomial(GF2x, GF2⁶)) == true
         for i in 1:length(test_cases)
             m, t = test_cases[i]
             if t == 1

test/test_ecc_bivaraite_bicycle_as_twobga.jl

@@ -1,4 +1,4 @@
-@testitem "ECC Bivaraite Bicycle as 2BGA" begin
+@testitem "ECC Bivaraite Bicycle as 2BGA" tags=[:ecc] begin
     using Hecke
     using HiGHS
     using JuMP

test/test_ecc_codeproperties.jl

@@ -1,4 +1,4 @@
-@testitem "ECC code properties" begin
+@testitem "ECC code properties" tags=[:ecc] begin
     using QuantumClifford.ECC
     using QuantumClifford.ECC: AbstractECC
 

test/test_ecc_color_codes.jl

@@ -1,4 +1,4 @@
-@testitem "ECC Color Codes" begin
+@testitem "ECC Color Codes" tags=[:ecc] begin
     using Hecke
     using JuMP
     using HiGHS

test/test_ecc_coprime_bivaraite_bicycle.jl

@@ -1,4 +1,4 @@
-@testitem "ECC coprime Bivaraite Bicycle" begin
+@testitem "ECC coprime Bivaraite Bicycle" tags=[:ecc] begin
     using Nemo
     using Nemo: gcd
     using Hecke

test/test_ecc_decoder_all_setups.jl

@@ -1,4 +1,4 @@
-@testitem "ECC Decoder" begin
+@testitem "ECC Decoder" tags=[:ecc] begin
     using QuantumClifford.ECC
 
     import PyQDecoders