Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch from TravisCI to Github Actions #10

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: ci/cd

on:
pull_request:
branches:
- 'main'
- 'develop'
push:
branches:
- 'main'
- 'develop'

jobs:
build:
name: Test on OTP ${{ matrix.otp_version }} and ${{ matrix.os }}
runs-on: ${{ matrix.os }}

strategy:
matrix:
otp_version: ['24', '23', '22', '21']
os: [ubuntu-latest]

steps:
- uses: actions/checkout@v2
- uses: erlef/setup-beam@v1
with:
otp-version: ${{ matrix.otp_version }}
rebar3-version: '3.15'

- name: Compile
run: rebar3 compile
- name: EUnit tests
run: rebar3 eunit
- name: Dialyzer
run: rebar3 dialyzer
- name: XRef
run: rebar3 xref

- name: Covertool
if: ${{ always() }}
run: rebar3 covertool generate
- uses: codecov/codecov-action@v1
with:
file: _build/test/covertool/elli_websocket.covertool.xml
env_vars: OTP_VERSION
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,11 @@ erl_crash.dump
logs
_build
.idea
*~
\#*\#
/.emacs.desktop
/.emacs.desktop.lock
*.elc
auto-save-list
tramp
.\#*
20 changes: 0 additions & 20 deletions .travis.yml

This file was deleted.

13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,22 @@

*A WebSocket handler for [elli][]*

[![Build Status][gh-actions-badge]][gh-actions]
[![Coverage Status][coveralls badge]][coveralls link]
[![Hex.pm][hex badge]][hex package]
[![Tags][github tags badge]][github tags]
[![Erlang][erlang badge]][erlang downloads]
[![Travis CI][travis badge]][travis builds]
[![Coverage Status][coveralls badge]][coveralls link]
[![Apache License][license badge]](LICENSE)

[elli]: https://github.com/elli-lib/elli
[hex badge]: https://img.shields.io/hexpm/v/elli_websocket.svg
[hex package]: https://hex.pm/packages/elli_websocket
[erlang badge]: https://img.shields.io/badge/erlang-%E2%89%A518.0-red.svg
[github tags]: https://github.com/elli-lib/elli_websocket/tags
[github tags badge]: https://img.shields.io/github/tag/elli-lib/elli_websocket.svg
[erlang badge]: https://img.shields.io/badge/erlang-%E2%89%A521.0-red.svg
[erlang downloads]: http://www.erlang.org/downloads
[travis builds]: https://travis-ci.org/elli-lib/elli_websocket
[travis badge]: https://travis-ci.org/elli-lib/elli_websocket.svg
[gh-actions-badge]: https://github.com/elli-lib/elli_websocket/workflows/ci%2Fcd/badge.svg
[gh-actions]: https://github.com/elli-lib/elli_websocket/actions
[coveralls badge]: https://coveralls.io/repos/github/elli-lib/elli_websocket/badge.svg?branch=develop
[coveralls link]: https://coveralls.io/github/elli-lib/elli_websocket?branch=develop
[license badge]: https://img.shields.io/hexpm/l/elli_websocket.svg
Expand Down
17 changes: 10 additions & 7 deletions rebar.config
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
{platform_define, "^2[1-9]", post20}
]}.

{deps, [
{elli, "3.3.0"}
]}.

{xref_checks, [undefined_function_calls, locals_not_used]}.

{dialyzer, [{base_plt_apps, [elli]}]}.
Expand All @@ -11,12 +15,10 @@
{test, [
{erl_first_files, [
"src/elli_websocket_handler"
]},
{deps, [{elli, "3.1.0"}]}
]}
]},
{docs, [
{deps, [
{elli, "3.1.0"},
{edown, "0.8.1"}
]}
]}
Expand All @@ -37,14 +39,15 @@
]}.

{project_plugins, [
{coveralls, "1.5.0"},
{covertool, "2.0.3"},
{rebar3_lint, "0.1.10"}
]}.

{provider_hooks, [{pre, [{eunit, lint}]}]}.

{cover_enabled, true}.
{cover_export_enabled, true}.
%% {cover_excl_mods, []}.
{coveralls_coverdata, "_build/test/cover/eunit.coverdata"}.
{coveralls_service_name, "travis-ci"}.
{cover_excl_mods, [
elli_handler
]}.
{covertool, [{coverdata_files, ["eunit.coverdata"]}]}.
7 changes: 0 additions & 7 deletions rebar.config.script

This file was deleted.

9 changes: 8 additions & 1 deletion rebar.lock
Original file line number Diff line number Diff line change
@@ -1 +1,8 @@
[].
{"1.2.0",
[{<<"elli">>,{pkg,<<"elli">>,<<"3.3.0">>},0}]}.
[
{pkg_hash,[
{<<"elli">>, <<"089218762A7FF3D20AE81C8E911BD0F73EE4EE0ED85454226D1FC6B4FFF3B4F6">>}]},
{pkg_hash_ext,[
{<<"elli">>, <<"698B13B33D05661DB9FE7EFCBA41B84825A379CCE86E486CF6AFF9285BE0CCF8">>}]}
].
2 changes: 1 addition & 1 deletion src/elli_websocket.app.src
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{application, elli_websocket, [
{description, "Elli WebSocket Handler."},
{vsn, "0.1.1"},
{vsn, "0.1.2"},
{modules, []},
{registered, []},
{applications, [kernel, stdlib, elli]},
Expand Down
44 changes: 26 additions & 18 deletions src/elli_ws_protocol.erl
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@

-module(elli_ws_protocol).

-include_lib("elli/src/elli_util.hrl").

%% Ignore the deprecation warning for crypto:sha/1.
%% @todo Remove when we support only R16B+.
-compile(nowarn_deprecated_function).
Expand Down Expand Up @@ -92,14 +94,16 @@ upgrade(Req, Env, Handler, HandlerOpts) ->
try websocket_upgrade(State, Req) of
{ok, State2, Req2} -> handler_init(State2, Req2, HandlerOpts)
catch
throw:Exc ->
handle_event(Req, Handler, websocket_throw, [Exc, erlang:get_stacktrace()], HandlerOpts),
throw:{ResponseCode, Headers, Body} when is_integer(ResponseCode) ->
{response, ResponseCode, Headers, Body};
?WITH_STACKTRACE(throw, Exc, Stacktrace)
handle_event(Req, Handler, websocket_throw, [Exc, Stacktrace], HandlerOpts),
elli_ws_request_adapter:maybe_reply(400, Req);
error:Error ->
handle_event(Req, Handler, websocket_error, [Error, erlang:get_stacktrace()], HandlerOpts),
?WITH_STACKTRACE(error, Error, Stacktrace)
handle_event(Req, Handler, websocket_error, [Error, Stacktrace], HandlerOpts),
elli_ws_request_adapter:maybe_reply(400, Req);
exit:Exit ->
handle_event(Req, Handler, websocket_exit, [Exit, erlang:get_stacktrace()], HandlerOpts),
?WITH_STACKTRACE(exit, Exit, Stacktrace)
handle_event(Req, Handler, websocket_exit, [Exit, Stacktrace], HandlerOpts),
elli_ws_request_adapter:maybe_reply(400, Req)
end.

Expand Down Expand Up @@ -169,14 +173,16 @@ handler_init(State=#state{env=Env, handler=Handler}, Req, HandlerOpts) ->
elli_ws_request_adapter:ensure_response(Req2, 400),
{ok, Req2, [{result, closed}|Env]}
catch
throw:Exc ->
handle_event(Req, Handler, websocket_throw, [Exc, erlang:get_stacktrace()], HandlerOpts),
throw:{ResponseCode, Headers, Body} when is_integer(ResponseCode) ->
{response, ResponseCode, Headers, Body};
?WITH_STACKTRACE(throw, Exc, Stacktrace)
handle_event(Req, Handler, websocket_throw, [Exc, Stacktrace], HandlerOpts),
elli_ws_request_adapter:maybe_reply(400, Req);
error:Error ->
handle_event(Req, Handler, websocket_error, [Error, erlang:get_stacktrace()], HandlerOpts),
?WITH_STACKTRACE(error, Error, Stacktrace)
handle_event(Req, Handler, websocket_error, [Error, Stacktrace], HandlerOpts),
elli_ws_request_adapter:maybe_reply(400, Req);
exit:Exit ->
handle_event(Req, Handler, websocket_exit, [Exit, erlang:get_stacktrace()], HandlerOpts),
?WITH_STACKTRACE(exit, Exit, Stacktrace)
handle_event(Req, Handler, websocket_exit, [Exit, Stacktrace], HandlerOpts),
elli_ws_request_adapter:maybe_reply(400, Req)
end.

Expand Down Expand Up @@ -665,12 +671,14 @@ handler_call(State=#state{handler=Handler}, Req, HandlerState,
{shutdown, Req2, HandlerState2} ->
websocket_close(State, Req2, HandlerState2, {normal, shutdown})
catch
throw:Exc ->
handle_event(Req, Handler, websocket_throw, [Exc, erlang:get_stacktrace()], HandlerState);
error:Error ->
handle_event(Req, Handler, websocket_error, [Error, erlang:get_stacktrace()], HandlerState);
exit:Exit ->
handle_event(Req, Handler, websocket_exit, [Exit, erlang:get_stacktrace()], HandlerState)
throw:{ResponseCode, Headers, Body} when is_integer(ResponseCode) ->
{response, ResponseCode, Headers, Body};
?WITH_STACKTRACE(throw, Exc, Stacktrace)
handle_event(Req, Handler, websocket_throw, [Exc, Stacktrace], HandlerState);
?WITH_STACKTRACE(error, Error, Stacktrace)
handle_event(Req, Handler, websocket_error, [Error, Stacktrace], HandlerState);
?WITH_STACKTRACE(exit, Exit, Stacktrace)
handle_event(Req, Handler, websocket_exit, [Exit, Stacktrace], HandlerState)
end.

websocket_opcode(text) -> 1;
Expand Down