Skip to content

Commit

Permalink
feat(#4): Open Source - release
Browse files Browse the repository at this point in the history 
* Added Apache LICENSE, README and CONTRIBUTING.
* Updated the tests to 100% coverage and added xref and dialyzer checks.
* Removed unused nbully_debug module.
* Other minor esthetic changes.

Closes #4.
  • Loading branch information
@Alberdi
Alberdi committed Jan 11, 2024
1 parent a3011db commit 8e5a161
Show file tree
Hide file tree
Showing 13 changed files with 481 additions and 194 deletions.
7 changes: 4 additions & 3 deletions .github/workflows/ci.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@ on:
branches: [main]

env:
REBAR3-VERSION: 3.20.0
REBAR3-VERSION: 3.22.1

jobs:
check:
runs-on: [self-hosted, linux]
runs-on: ubuntu-latest
strategy:
matrix:
otp: ['25.3.2']
otp: ['26.2.1']
steps:
- uses: actions/checkout@v3

Expand Down Expand Up @@ -45,7 +46,7 @@ jobs:
- run: rebar3 test

- name: Create test summary
uses: test-summary/action@v1
uses: test-summary/action@v2
if: always()
with:
paths: '_build/test/logs/**/report.xml'
68 changes: 68 additions & 0 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Contributing to nbully

Any contribution is welcome. Here you have the guidelines you must follow to contribute to the project.

## Table of Contents
[Doubts or questions](#doubts-or-questions)
[Documentation](#documentation)
[Bug reports](#bug-reports)
[Feature requests](#feature-requests)
[Development](#development)

## Doubts or questions

If you have any doubt or question about the project, please:

1. Read the [documentation](README.md) in case it helps you to clarify the concepts.
2. Check out [the issue tracker](https://github.com/nomasystems/nbully/issues?q=is%3Aissue+label%3Aquestion). Maybe your question is already reflected there.
3. If none of the above makes it clearer for you, create a new question in the issue tracker. The team will try to answer as soon as possible.

## Documentation

Do you find that something is missing/wrong in the docs? Please, create a new documentation issue in the issue tracker. We will get back to you as soon as possible.

## Bug reports

Bug reports help us improve the code. We take them very seriously and thank you for taking the time to create them.

If you find a bug in the code, please:

1. Read the [documentation](README.md) to make sure you find an unexpected behaviour.
2. Check out [the issue tracker](https://github.com/nomasystems/nbully/issues?q=is%3Aissue+label%3Abug). Maybe your bug report is already reflected there.
3. If you still think this is a new bug report, please create a new bug report in the issue tracker, and make sure you fill all the fields so the person solving the problem has all the necessary information.

## Feature requests

Feature requests are welcome. If you think that the project is missing a feature, please:

1. Read the [documentation](README.md) to make sure the feature is not already included.
2. Check out [the issue tracker](https://github.com/nomasystems/nbully/issues?q=is%3Aissue+label%3Aenhancement). Maybe your feature was already requested by someone else.
3. If your feature is not reflected in any of the above, please create a new feature request in the issue tracker, giving as much context and detail as needed.

## Development

In order to develop something for the project, you must follow these rules:

1. Find an appropriate issue to solve:
* Only verified issues with complete information must be addressed (avoid issues with label `needs triage`, as they must be reviewed by the nomasystems group).
* If an issue is already assigned to another user, it means that this user is already solving the issue. Please, respect other people's work and don't interfere.
* Issues labeled with `good first issue` are quicker and simpler, so they can be a good starting point when contributing.
2. Assign the issue to yourself, so other developers know that you are already working on it. Don't be ashamed if you find later that you won't be able to solve the issue, just left it unassigned so someone else can work on it.
3. Create a branch to solve the issue:
* If the issue has the label `documentation`:
- The new branch must be created from the branch named `develop`.
- The name of the new branch must be `docs/{IssueIdentifier}-{IssueTitle in kebab-case}`.
* If the issue has the label `bug`:
- The new branch must be created from the branch named `main`.
- The name of the new branch must be `bugfix/{IssueIdentifier}-{IssueTitle in kebab-case}`.
* If the issue has the label `enhancement`:
- The new branch must be created from the branch named `develop`.
- The name of the new branch must be `feature/{IssueIdentifier}-{IssueTitle in kebab-case}`.
4. Make the changes in the new branch. Don't forget to:
* Add new test cases checking that the bug is solved / the new feature is successfully implemented.
* Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to create commit messages. If a commit closes an issue, the footer must include the expression `closes #IssueIdentifier`.
5. When the issue is solved, create a new pull request:
* Add a description with the changes you've made.
* Link the issue to the PR.
* Left it unassigned, someone from the nomasystems group will review it as soon as possible.

202 changes: 202 additions & 0 deletions LICENSE
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
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

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed 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.

49 changes: 49 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# nbully

An OTP application for leader election.

The nbully application starts a supervisor that supervises a worker process. This process runs in every node and consensuates node leadership with its homologues in other nodes.

## Status
[![GitHub branch checks state](https://github.com/nomasystems/nbully/actions/workflows/ci.yml/badge.svg)](https://github.com/nomasystems/nbully/actions/workflows/ci.yml)

## Prerequisites

![Min. OTP version](https://img.shields.io/badge/min._OTP-25.3.2-blue)
![Max. OTP version](https://img.shields.io/badge/max._OTP-26-blue)
![Min. rebar version](https://img.shields.io/badge/min._rebar-3.22.X-blue)

## Usage

In your `rebar.config` file, add the dependency:
```erl
{deps, [
{nbully, {git, "[email protected]:nomasystems/nbully.git", {branch, "main"}}}
]}.
```

Then, once the application is started, you can consult `nbully:leader/0` to know which node is the current leader. This value is the same for all nodes connected through `net_kernel` and might only change when nodes go up or down.

You can also use `nbully:subscribe/0` to receive live updates when the leader changes in the form of a message `{nbully_leader_update, Node}`. For example:

```erl
ok = nbully:subscribe(),
InitialLeader = nbully:leader(),
% [...]
NewLeader =
receive
{nbully_leader_update, Node} -> Node
after 1000 -> InitialLeader
end,
LeaderIsMe = node() =:= NewLeader,
% [...]
ok = nbully:unsubscribe().
```
## Support

Any doubt or suggestion? Please, check out [our issue tracker](https://github.com/nomasystems/nbully/issues).

## Contributing

Pull requests are welcome. Please read the [contributing guidelines](CONTRIBUTING.md) to know more about contribution.

19 changes: 17 additions & 2 deletions rebar.config
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,28 @@

{alias, [
{check, [
{fmt, "--check"}
{fmt, "--check"},
xref,
dialyzer
]},
{test, [
{ct, "--sname nbully --spec test/conf/test.spec --cover --readable true"}
{ct, "--sname nbully --spec test/conf/test.spec --cover --readable true"},
{cover, "-m 100"}
]}
]}.

{xref_ignores, [
{nbully, leader, 0},
{nbully, subscribe, 0},
{nbully, unsubscribe, 0},
{nbully_wrk, init, 1},
{nbully_wrk, start_link, 0},
{nbully_wrk, stop, 0},
{nbully_wrk, system_code_change, 4},
{nbully_wrk, system_continue, 3},
{nbully_wrk, system_terminate, 4}
]}.

{profiles, [
{test, [
{deps, [
Expand Down
2 changes: 1 addition & 1 deletion src/nbully.app.src
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
%%% -*- mode:erlang -*-
{application, nbully, [
{description, "Shortcut implementation of bully leader election algorithm"},
{vsn, "1.0.0"},
{vsn, "1.0.1"},
{registered, [nbully_sup, nbully_wrk]},
{applications, [kernel, stdlib]},
{mod, {nbully, []}},
Expand Down
Loading

0 comments on commit 8e5a161

Please sign in to comment.