-
Notifications
You must be signed in to change notification settings - Fork 517
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2628 from apache/intro-commons-v2
**TODO:** After this PR merged, change the README in commons & pin a [issue](hugegraph/hugegraph-hubble#371) to notify all users/devs to know the context (also update the repo description...) Finally, we may need start a discussion for marking commons repo in achieved status
- Loading branch information
Showing
259 changed files
with
34,212 additions
and
30 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
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,64 @@ | ||
| name: "HugeGraph-Commons CI" | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| push: | ||
| branches: | ||
| - master | ||
| - /^release-.*$/ | ||
| - /^test-.*$/ | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| build-commons: | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| # TODO: reset use stage to false later | ||
| USE_STAGE: 'true' # Whether to include the stage repository. | ||
|
|
||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| JAVA_VERSION: ['11'] | ||
|
|
||
| steps: | ||
| - name: Install JDK ${{ matrix.JAVA_VERSION }} | ||
| uses: actions/setup-java@v3 | ||
| with: | ||
| java-version: ${{ matrix.JAVA_VERSION }} | ||
| distribution: 'zulu' | ||
|
|
||
| - name: Cache Maven packages | ||
| uses: actions/cache@v3 | ||
| with: | ||
| path: ~/.m2 | ||
| key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} | ||
| restore-keys: ${{ runner.os }}-m2 | ||
|
|
||
| - name: Checkout | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 2 | ||
|
|
||
| - name: Use staged maven repo settings | ||
| if: ${{ env.USE_STAGE == 'true' }} | ||
| run: | | ||
| cp $HOME/.m2/settings.xml /tmp/settings.xml | ||
| cp -vf .github/configs/settings.xml $HOME/.m2/settings.xml && cat $HOME/.m2/settings.xml | ||
| - name: Compile | ||
| run: | | ||
| mvn compile -Dmaven.javadoc.skip=true -ntp | ||
| - name: Run common test | ||
| run: | | ||
| mvn test -pl hugegraph-commons/hugegraph-common -Dtest=UnitTestSuite | ||
| - name: Run rpc test | ||
| run: | | ||
| mvn test -pl hugegraph-commons/hugegraph-rpc -Dtest=UnitTestSuite | ||
| - name: Upload coverage to Codecov | ||
| uses: codecov/codecov-action@v3.0.0 | ||
| with: | ||
| file: target/jacoco.xml |
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
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,66 @@ | ||
| # hugegraph-commons | ||
|
|
||
| [](https://www.apache.org/licenses/LICENSE-2.0.html) | ||
| [](https://codecov.io/gh/hugegraph/hugegraph-common) | ||
| [](https://mvnrepository.com/artifact/org.apache.hugegraph/hugegraph-common) | ||
| [](https://github.com/apache/incubator-hugegraph-commons/actions/workflows/codeql-analysis.yml) | ||
| [](https://github.com/apache/incubator-hugegraph-commons/actions/workflows/ci.yml) | ||
|
|
||
|
|
||
| hugegraph-commons is a common module for [HugeGraph](https://github.com/apache/hugegraph) and its peripheral components. | ||
| hugegraph-commons encapsulates locks, configurations, events, iterators, rest and some | ||
| numeric or collection util classes to simplify the development of HugeGraph and its components. | ||
|
|
||
| ## Components | ||
|
|
||
| - Lock: atomic lock, key lock, lock group and lock manger | ||
| - Config: register and load config option with security check | ||
| - Event: listening and notification, do something asynchronously | ||
| - Iterator: some iterators with extra functions, map, filter, extend, etc. | ||
| - Rest: RESTful client implemented on OkHttp, POST, PUT, GET and DELETE | ||
| - Util: performance analyzer, version checker, numeric and Collection utils, log and exception utils, etc. | ||
| - Rpc: rpc component for inner module communication, currently it's based on [Sofa-RPC](https://github.com/sofastack/sofa-rpc) | ||
|
|
||
| You could use import the dependencies in `maven` like this: | ||
|
|
||
| ```xml | ||
| <dependency> | ||
| <groupId>org.apache.hugegraph</groupId> | ||
| <artifactId>hugegraph-common</artifactId> | ||
| <version>1.2.0</version> | ||
| </dependency> | ||
| ``` | ||
|
|
||
| ## Learn More | ||
|
|
||
| The [doc page](https://hugegraph.apache.org/docs/) contains more information about hugegraph modules. | ||
|
|
||
| And here are links of other repositories: | ||
| 1. [hugegraph-server](https://github.com/apache/hugegraph) (graph's core component - OLTP server) | ||
| 2. [hugegraph-toolchain](https://github.com/apache/hugegraph-toolchain) (include loader/dashboard/tool/client) | ||
| 3. [hugegraph-computer](https://github.com/apache/hugegraph-computer) (graph processing system - OLAP) | ||
| 4. [hugegraph-website/doc](https://github.com/apache/hugegraph-doc) (include doc & website code) | ||
|
|
||
|
|
||
|
|
||
| ## Contributing | ||
|
|
||
| - Welcome to contribute to HugeGraph, please see [How to Contribute](https://hugegraph.apache.org/docs/contribution-guidelines/contribute/) for more information. | ||
| - Note: It's recommended to use [GitHub Desktop](https://desktop.github.com/) to greatly simplify the PR and commit process. | ||
| - Thank you to all the people who already contributed to HugeGraph! | ||
|
|
||
| [](https://github.com/apache/incubator-hugegraph-commons/graphs/contributors) | ||
|
|
||
| ## Licence | ||
|
|
||
| Same as HugeGraph, hugegraph-commons are also licensed under [Apache 2.0](./LICENSE) License. | ||
|
|
||
| ### Contact Us | ||
|
|
||
| --- | ||
|
|
||
| - [GitHub Issues](https://github.com/apache/incubator-hugegraph-commons/issues): Feedback on usage issues and functional requirements (quick response) | ||
| - Feedback Email: [dev@hugegraph.apache.org](mailto:dev@hugegraph.apache.org) ([subscriber](https://hugegraph.apache.org/docs/contribution-guidelines/subscribe/) only) | ||
| - WeChat public account: Apache HugeGraph, welcome to scan this QR code to follow us. | ||
|
|
||
| <img src="https://raw.githubusercontent.com/apache/incubator-hugegraph-doc/master/assets/images/wechat.png" alt="QR png" width="350"/> |
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,23 @@ | ||
| # hugegraph-common | ||
|
|
||
| [](https://www.apache.org/licenses/LICENSE-2.0.html) | ||
| [](https://travis-ci.org/hugegraph/hugegraph-common) | ||
| [](https://codecov.io/gh/hugegraph/hugegraph-common) | ||
| [](https://mvnrepository.com/artifact/org.apache.hugegraph/hugegraph-common) | ||
|
|
||
| hugegraph-common is a common module for [HugeGraph](https://github.com/hugegraph/hugegraph) and its peripheral components. | ||
| hugegraph-common encapsulates locks, configurations, events, iterators, rest and some | ||
| numeric or collection util classes to simplify the development of HugeGraph and | ||
| its components. | ||
|
|
||
| ## Components | ||
|
|
||
| - Lock: atomic lock, key lock, lock group and lock manger | ||
| - Config: register and load config option with security check | ||
| - Event: listening and notification, do something asynchronously | ||
| - Iterator: some iterators with extra functions, map, filter, extend, etc. | ||
| - Rest: RESTful client implemented on Jersey, POST, PUT, GET and DELETE | ||
| - Util: Performance analyzer, version checker, numeric and Collection utils, log and exception utils, etc. | ||
|
|
||
| ## Licence | ||
| The same as HugeGraph, hugegraph-common is also licensed under Apache 2.0 License. |
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,23 @@ | ||
| #!/usr/bin/env bash | ||
| # | ||
| # Licensed to the Apache Software Foundation (ASF) under one or more | ||
| # contributor license agreements. See the NOTICE file distributed with | ||
| # this work for additional information regarding copyright ownership. | ||
| # The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| # (the "License"); you may not use this file except in compliance with | ||
| # the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| # | ||
|
|
||
| export MAVEN_HOME=/home/scmtools/buildkit/maven/apache-maven-3.3.9/ | ||
| export JAVA_HOME=/home/scmtools/buildkit/java/jdk1.8.0_25/ | ||
| export PATH=$JAVA_HOME/bin:$MAVEN_HOME/bin:$PATH | ||
|
|
||
| mvn clean test -Dtest=UnitTestSuite |
Oops, something went wrong.