From 50d9588f94513059dd7e118cd2e005d26dfdcdc8 Mon Sep 17 00:00:00 2001 From: magine Date: Sun, 7 Jul 2024 15:12:26 +0800 Subject: [PATCH] Add ci and auto release --- .github/workflows/build.yml | 55 ------- .github/workflows/build_then_release.yml | 112 +++++++++++++++ .github/workflows/check_and_test.yml | 43 ++++++ Cargo.toml | 8 +- LICENSE | 176 +++++++++++++++++++++++ src/lib.rs | 3 + 6 files changed, 340 insertions(+), 57 deletions(-) delete mode 100644 .github/workflows/build.yml create mode 100644 .github/workflows/build_then_release.yml create mode 100644 .github/workflows/check_and_test.yml create mode 100644 LICENSE diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml deleted file mode 100644 index 67074ab..0000000 --- a/.github/workflows/build.yml +++ /dev/null @@ -1,55 +0,0 @@ -name: build - -on: - push: - branches: - - master - tags: - - v* - pull_request: - branches: - - master - -permissions: - contents: write - -jobs: - build-rust: - strategy: - matrix: - platform: [ubuntu-latest] - runs-on: ${{ matrix.platform }} - steps: - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - submodules: recursive - - name: Install Rust - run: rustup toolchain install stable --component llvm-tools-preview - - name: Install cargo-llvm-cov - uses: taiki-e/install-action@cargo-llvm-cov - - name: install nextest - uses: taiki-e/install-action@nextest - - uses: Swatinem/rust-cache@v2 - - name: Check code format - run: cargo fmt -- --check - - name: Check the package for errors - run: cargo check --all - - name: Lint rust sources - run: cargo clippy --all-targets --all-features --tests --benches -- -D warnings - - name: Execute rust tests - run: cargo nextest run --all-features - - name: Generate a changelog - uses: orhun/git-cliff-action@v2 - id: git-cliff - if: startsWith(github.ref, 'refs/tags/') - with: - config: cliff.toml - args: -vv --latest --strip header - env: - OUTPUT: CHANGES.md - - name: Release - uses: softprops/action-gh-release@v1 - if: startsWith(github.ref, 'refs/tags/') - with: - body: ${{ steps.git-cliff.outputs.content }} diff --git a/.github/workflows/build_then_release.yml b/.github/workflows/build_then_release.yml new file mode 100644 index 0000000..6b1ac3e --- /dev/null +++ b/.github/workflows/build_then_release.yml @@ -0,0 +1,112 @@ +name: Build then release + +on: + push: + tags: + - "v*" + branches: + - "master" + +env: + CARGO_TERM_COLOR: always + +jobs: + gen_version: + name: Generate version + runs-on: ubuntu-latest + outputs: + version: ${{ steps.generated-tag.outputs.tag }} + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Get latest tag + id: get-latest-tag + run: | + echo "tag=`gh release list -L 1 | cut -f 1`" >> $GITHUB_OUTPUT + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - name: Bump version + id: generated-tag + uses: actions/github-script@v6 + with: + script: | + if (context.ref.startsWith("refs/tags/")) { + let tag = context.ref.replace("refs/tags/", ""); + core.setOutput('tag', tag); + console.log(`This event pushed a tag ${tag}, return directly.`) + return + } + console.log('Use default tag "prerelease".') + core.setOutput('tag', 'prerelease'); + + build: + needs: gen_version + name: Build + runs-on: ${{ matrix.runner }} + strategy: + matrix: + include: + - { target: x86_64-apple-darwin, runner: macos-latest } + - { target: aarch64-apple-darwin, runner: macos-latest } + - { target: x86_64-unknown-linux-musl, runner: ubuntu-latest } + - { target: aarch64-unknown-linux-musl, runner: ubuntu-latest } + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Setup protoc + uses: arduino/setup-protoc@v3.0.0 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + - name: Install musl-tools + if: matrix.runner == 'ubuntu-latest' + run: sudo apt update && sudo apt install -y musl-tools + - name: Add target + run: rustup target add ${{ matrix.target }} + - name: Setup rust toolchain + run: rustup show + - uses: Swatinem/rust-cache@v2 + with: + shared-key: build-then-release-${{ matrix.target }}-v1 + - name: Build + run: | + cargo build --release --target ${{ matrix.target }} + zip -j pproxy-${{ needs.gen_version.outputs.version }}-${{ matrix.target }}.zip ./target/${{ matrix.target }}/release/pproxy + - uses: actions/upload-artifact@v4 + name: Upload artifacts + with: + name: pproxy-${{ needs.gen_version.outputs.version }}-${{ matrix.target }} + path: pproxy-${{ needs.gen_version.outputs.version }}-${{ matrix.target }}.zip + retention-days: 1 + + release: + needs: [gen_version, build] + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: Generate changelog + uses: orhun/git-cliff-action@v3 + id: git-cliff + with: + config: cliff.toml + args: "-vv --strip header ${{ needs.gen_version.outputs.version == 'prerelease' && '--unreleased' || '--latest' }}" + - uses: actions/download-artifact@v3 + - name: Display fetched artifacts + run: ls -R + - uses: softprops/action-gh-release@v2.0.4 + name: Emit a Github Release + with: + token: "${{ secrets.GITHUB_TOKEN }}" + body: "${{ steps.git-cliff.outputs.content }}" + tag_name: ${{ needs.gen_version.outputs.version }} + prerelease: ${{ needs.gen_version.outputs.version == 'prerelease' }} + title: ${{ needs.gen_version.outputs.version }} + files: | + LICENSE + pproxy-${{ needs.gen_version.outputs.version }}-x86_64-apple-darwin/*.zip + pproxy-${{ needs.gen_version.outputs.version }}-aarch64-apple-darwin/*.zip + pproxy-${{ needs.gen_version.outputs.version }}-x86_64-unknown-linux-musl/*.zip + pproxy-${{ needs.gen_version.outputs.version }}-aarch64-unknown-linux-musl/*.zip diff --git a/.github/workflows/check_and_test.yml b/.github/workflows/check_and_test.yml new file mode 100644 index 0000000..d32393b --- /dev/null +++ b/.github/workflows/check_and_test.yml @@ -0,0 +1,43 @@ +name: Check and test + +on: + push: + branches: + - master + pull_request: + branches: + - master + +env: + CARGO_TERM_COLOR: always + +jobs: + test: + name: Check and test + strategy: + matrix: + platform: [ubuntu-latest] + runs-on: ${{ matrix.platform }} + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Setup protoc + uses: arduino/setup-protoc@v3.0.0 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + - name: Setup rust toolchain + run: rustup show + - name: Install nextest + uses: taiki-e/install-action@nextest + - uses: Swatinem/rust-cache@v2 + with: + shared-key: check-and-test-${{ matrix.platform }}-v1 + - name: Check code format + run: cargo fmt -- --check + - name: Check the package for errors + run: cargo check --all + - name: Lint rust sources + run: cargo clippy --all-targets --all-features --tests --benches -- -D warnings + - name: Execute rust tests + run: cargo nextest run --all-features diff --git a/Cargo.toml b/Cargo.toml index 10ee931..7210680 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -15,11 +15,11 @@ http-body-util = "0.1.1" httparse = "1.8.0" hyper = { version = "1.3.1", features = ["server", "http1"] } hyper-util = { version = "0.1.5", features = ["tokio"] } -litep2p = { git = "https://github.com/Ma233/litep2p.git", branch = "pproxy-patch" } +litep2p = { git = "https://github.com/Ma233/litep2p.git", rev = "144d81c" } # Do not upgrade multiaddr, see: https://github.com/paritytech/litep2p/pull/91 multiaddr = "0.17.1" percent-encoding = "2.3.1" -prost = "0.12.4" +prost = "0.12.6" thiserror = "1.0.60" tokio = { version = "1.37.0", features = ["rt-multi-thread"] } tokio-util = "0.7.11" @@ -30,3 +30,7 @@ tracing-subscriber = { version = "0.3.18", features = ["env-filter"] } [build-dependencies] tonic-build = "0.11.0" + +[[bin]] +name = "pproxy" +path = "src/main.rs" diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d9a10c0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/src/lib.rs b/src/lib.rs index 4e652c9..d649e1d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -156,6 +156,9 @@ impl PProxy { tracing::debug!("received P2pServerEvent: {:?}", event); #[allow(clippy::single_match)] match event { + P2pServerEvent::Litep2p(ev) => { + tracing::debug!("received Litep2p event: {:?}", ev); + } P2pServerEvent::TunnelEvent(RequestResponseEvent::RequestReceived { peer, request_id,