partial test and code format during pkg test (#34)

* improve test and code format

- add code format in pkg test. The code format will only run incrementally based on `git diff`, so it's much faster
- do an incremental test on problems locally (also based on `git diff`). CI still tests against all problems.
- run each problem in a sandbox module so it won't get affected by other codes.
- remove auto format CI since format is run locally during pkg test

* test/format based on git diff HEAD~1

* use Github Action for unit test

* move format_utils to test

* 1.3 compat

Author: johnnychen94

.github/workflows/UnitTest.yml

@@ -0,0 +1,44 @@
+name: Unit test
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+  schedule:
+    - cron: '20 00 1 * *'
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        julia-version: ['1.3', '1', 'nightly']
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+
+    steps:
+      - uses: actions/[email protected]
+      - name: "Set up Julia"
+        uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.julia-version }}
+
+      - name: Cache artifacts
+        uses: actions/cache@v1
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts 
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - name: "Unit Test"
+        uses: julia-actions/julia-runtest@master
+
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v1
+        with:
+          file: lcov.info

.github/workflows/format_pr.yml

@@ -12,10 +12,13 @@ Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
 [compat]
 BenchmarkTools = "0.5"
 DataStructures = "0.18"
+JuliaFormatter = "0.10"
 julia = "1.3"
 
 [extras]
+JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
+LibGit2 = "76f85450-5226-5b5a-8eaa-529ad045b433"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test"]
+test = ["JuliaFormatter", "LibGit2", "Test"]

.travis.yml

@@ -1,18 +1,25 @@
 # LeetCode in Julia - 用 Julia 编写力扣题目
 
-[![Build Status](https://travis-ci.com/JuliaCN/LeetCode.jl.svg?branch=master)](https://travis-ci.com/JuliaCN/LeetCode.jl) [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
+[![Unit Test][action-img]][action-url]
+[![Code Style: Blue][blue-img]][blue-url]
 
 社区驱动的项目：用 Julia 做 LeetCode 题目
 
 ## 如何做出贡献？
 
 1. [Fork](https://guides.github.com/activities/forking/) 本项目
-1. 使用 `git clone` 本项目
-1. 在 `src/problems/` 路径下新建一个文件夹。
+2. 使用 `git clone` 本项目
+3. 在 `src/problems/` 路径下新建一个文件夹。
     你可能会想要使用像 [leetcode-cli](https://github.com/skygragon/leetcode-cli) 这样辅助工具，
     通过 `leetcode show 1 -g -x -l python` 命令来生成一个 `python` 的模板，并将其重命名为 `.jl` 文件。
     （如果你使用 VSCode 你也可能需要 [LeetCode VSCode 插件](https://marketplace.visualstudio.com/items?itemName=LeetCode.vscode-leetcode)）
-1. 在 `test/problems` 文件夹下编写测试样例，确保你的解答能满足题目的要求。
-1. 对于一些共同的组件，将他们放到 `src/common.jl` 中，并在 `test/common.jl` 里添加测试。
-1. 提交（commit）你的更改，并开启一个新的合并请求（pull request）。
-1. 你还可以 **关注（WATCH）** 此项目以帮助审阅其他人的合并请求，或者 **点个赞（STAR）** 以鼓励本项目的贡献者们。
+4. 在 `test/problems` 文件夹下编写测试样例，确保你的解答能满足题目的要求。
+5. 对于一些共同的组件，将他们放到 `src/common.jl` 中，并在 `test/common.jl` 里添加测试。
+6. 通过 `pkg> test` 测试结果是否正确， 测试过程会格式化代码
+7. 提交（commit）你的更改，并开启一个新的合并请求（pull request）。
+8. 你还可以 **关注（WATCH）** 此项目以帮助审阅其他人的合并请求，或者 **点个赞（STAR）** 以鼓励本项目的贡献者们。
+
+[action-img]: https://github.com/JuliaCN/LeetCode.jl/workflows/Unit%20test/badge.svg
+[action-url]: https://github.com/JuliaCN/LeetCode.jl/actions
+[blue-img]: https://img.shields.io/badge/code%20style-blue-4495d1.svg
+[blue-url]: https://github.com/invenia/BlueStyle

Project.toml

@@ -1,6 +1,7 @@
 # LeetCode
 
-[![Build Status](https://travis-ci.com/JuliaCN/LeetCode.jl.svg?branch=master)](https://travis-ci.com/JuliaCN/LeetCode.jl) [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
+[![Unit Test][action-img]][action-url]
+[![Code Style: Blue][blue-img]][blue-url]
 
 
 [中文说明](README-zh-cn.md)
@@ -10,8 +11,14 @@ A community driven project to provide solutions for LeetCode problems in the Jul
 ## How to contribute?
 
 1. [Fork](https://guides.github.com/activities/forking/) this project.
-1. Create a new problem file under the `src/problems/` folder. You may want to use tools like [leetcode-cli](https://github.com/skygragon/leetcode-cli) with the command like `leetcode show 1 -g -x -l python` to generate a `python` template and then modify the code and rename it into a `.jl` file. (You may also consider [LeetCode VSCode Plugin](https://marketplace.visualstudio.com/items?itemName=LeetCode.vscode-leetcode) if you use VSCode)
-1. Write test cases inside the `test/problems` folder to make sure the solutions work as expected.
-1. For some common components, please put them into the `src/common.jl` file and add test cases in `test/common.jl`.
-1. Commit your changes and make a pull request.
-1. You may also **WATCH** this project to help review other's PR or **STAR** this project to spread JuliaLang to others.
+2. Create a new problem file under the `src/problems/` folder. You may want to use tools like [leetcode-cli](https://github.com/skygragon/leetcode-cli) with the command like `leetcode show 1 -g -x -l python` to generate a `python` template and then modify the code and rename it into a `.jl` file. (You may also consider [LeetCode VSCode Plugin](https://marketplace.visualstudio.com/items?itemName=LeetCode.vscode-leetcode) if you use VSCode)
+3. Write test cases inside the `test/problems` folder to make sure the solutions work as expected.
+4. For some common components, please put them into the `src/common.jl` file and add test cases in `test/common.jl`.
+5. Run `pkg> test` locally to make sure test passes. The test will also format your codes.
+6. Commit your changes and make a pull request.
+7. You may also **WATCH** this project to help review other's PR or **STAR** this project to spread JuliaLang to others.
+
+[action-img]: https://github.com/JuliaCN/LeetCode.jl/workflows/Unit%20test/badge.svg
+[action-url]: https://github.com/JuliaCN/LeetCode.jl/actions
+[blue-img]: https://img.shields.io/badge/code%20style-blue-4495d1.svg
+[blue-url]: https://github.com/invenia/BlueStyle

README-zh-cn.md

@@ -0,0 +1,52 @@
+using LibGit2
+using LibGit2.Consts: DELTA_ADDED, DELTA_MODIFIED, DELTA_DELETED
+using JuliaFormatter
+
+const DEFAULT_DIFF_FILTER = Set((
+    LibGit2.Consts.DELTA_ADDED,
+    LibGit2.Consts.DELTA_MODIFIED,
+    # LibGit2.Consts.DELTA_DELETED # only need to format existing files
+))
+
+# modified based on LibGit2.diff_files
+function diff_files(repo, tree, pathspecs=""; filter=DEFAULT_DIFF_FILTER)
+    tree = LibGit2.GitTree(repo, tree * "^{tree}")
+    files = String[]
+    try
+        diff = LibGit2.diff_tree(repo, tree, pathspecs)
+        for i in 1:LibGit2.count(diff)
+            delta = diff[i]
+            delta === nothing && break
+            if LibGit2.Consts.DELTA_STATUS(delta.status) in filter
+                push!(files, unsafe_string(delta.new_file.path))
+            end
+        end
+        close(diff)
+    catch
+        close(tree)
+    end
+    return files
+end
+
+"""
+    format_diff_file(root, tree="HEAD", pathspecs=""; filter)
+
+Apply JuliaFormatter to git diff (.jl) files.
+
+# Inputs
+
+- `root::String`: the root path to the git repo
+- `tree::String`: git tree spec
+- `pathspecs::String=""`: same to `git diff -- <pathspecs>`
+- `filter=identity`: a function that used to filter out files of interested.
+"""
+function format_diff_file(root::String, tree="HEAD", pathspecs::String=""; filter=identity)
+    repo = LibGit2.GitRepo(root)
+
+    jl_diff = Base.filter(
+        x -> endswith(x, ".jl"), joinpath.(root, diff_files(repo, tree, pathspecs))
+    )
+    for file in filter(jl_diff)
+        format(file, BlueStyle(); verbose=true)
+    end
+end

README.md

@@ -1,7 +1,25 @@
 @testset "problems" begin
-    for f in readdir(@__DIR__)
-        if f != splitdir(@__FILE__)[2]
-            include(f)
+    is_ci = get(ENV, "CI", nothing) == "true"
+    if is_ci
+        test_files = filter(isfile, joinpath.(@__DIR__, readdir(@__DIR__)))
+    else
+        repo = LibGit2.GitRepo(root)
+        problem_dir = relpath(@__DIR__, root) # "test/problems"
+
+        test_files = filter(diff_files(repo, "HEAD~1", "")) do f
+            startswith(f, problem_dir) && endswith(f, ".jl")
         end
     end
+    # don't recursively include "problem.jl" itself
+    test_files = filter(x -> x != "problems.jl", basename.(test_files))
+
+    @info "testing $(length(test_files)) problems" CI = is_ci
+    for f in test_files
+        # run tests in a sandbox
+        m = Module(gensym())
+        # modules created with Module() does not have include defined
+        Core.eval(m, :(include(x) = Base.include($m, x)))
+        Core.eval(m, :(include("../requirements.jl")))
+        Core.eval(m, :(include($f)))
+    end
 end

test/format_utils.jl

@@ -0,0 +1,2 @@
+using LeetCode
+using Test

test/problems/problems.jl

@@ -1,7 +1,16 @@
 using LeetCode
 using Test
+include("format_utils.jl")
+
+# Every problem is run in a sandbox environment, test requirements are put into "requirements.jl"
+# and will be included for each single problem.
+
+root = abspath(@__DIR__, "..")
 
 @testset "LeetCode.jl" begin
     include("common.jl")
     include("problems/problems.jl")
 end
+
+# trigger an auto-format after test
+format_diff_file(root, "HEAD~1")