From 439b1c65b055da06b7cc9b467026142f79ddc259 Mon Sep 17 00:00:00 2001 From: WWW_cool Date: Wed, 17 Feb 2021 12:47:57 +0300 Subject: [PATCH] initial --- Dockerfile.sh | 24 +++++ Jenkinsfile | 22 ++++ LICENSE | 176 +++++++++++++++++++++++++++++++ Makefile | 77 ++++++++++++++ README.md | 2 + apps/limiter/src/limiter.app.src | 18 ++++ config/sys.config | 96 +++++++++++++++++ config/vm.args | 3 + docker-compose.sh | 45 ++++++++ elvis.config | 89 ++++++++++++++++ rebar.config | 121 +++++++++++++++++++++ 11 files changed, 673 insertions(+) create mode 100755 Dockerfile.sh create mode 100644 Jenkinsfile create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.md create mode 100644 apps/limiter/src/limiter.app.src create mode 100644 config/sys.config create mode 100644 config/vm.args create mode 100755 docker-compose.sh create mode 100644 elvis.config create mode 100644 rebar.config diff --git a/Dockerfile.sh b/Dockerfile.sh new file mode 100755 index 0000000..e9d6f66 --- /dev/null +++ b/Dockerfile.sh @@ -0,0 +1,24 @@ +#!/bin/bash +cat < +RUN mkdir -p /var/log/limiter +COPY ./_build/prod/rel/limiter /opt/limiter +WORKDIR /opt/limiter +CMD /opt/limiter/bin/limiter foreground +EXPOSE 8022 +LABEL com.rbkmoney.$SERVICE_NAME.parent=$BASE_IMAGE_NAME \ + com.rbkmoney.$SERVICE_NAME.parent_tag=$BASE_IMAGE_TAG \ + com.rbkmoney.$SERVICE_NAME.build_img=build \ + com.rbkmoney.$SERVICE_NAME.build_img_tag=$BUILD_IMAGE_TAG \ + com.rbkmoney.$SERVICE_NAME.commit_id=$(git rev-parse HEAD) \ + com.rbkmoney.$SERVICE_NAME.commit_number=$(git rev-list --count HEAD) \ + com.rbkmoney.$SERVICE_NAME.branch=$( \ + if [ "HEAD" != $(git rev-parse --abbrev-ref HEAD) ]; then \ + echo $(git rev-parse --abbrev-ref HEAD); \ + elif [ -n "$BRANCH_NAME" ]; then \ + echo $BRANCH_NAME; \ + else \ + echo $(git name-rev --name-only HEAD); \ + fi) +EOF diff --git a/Jenkinsfile b/Jenkinsfile new file mode 100644 index 0000000..3265915 --- /dev/null +++ b/Jenkinsfile @@ -0,0 +1,22 @@ +#!groovy +// -*- mode: groovy -*- + +def finalHook = { + runStage('store CT logs') { + archive '_build/test/logs/' + } +} + +build('limiter', 'docker-host', finalHook) { + checkoutRepo() + loadBuildUtils() + + def pipeErlangService + runStage('load pipeline') { + env.JENKINS_LIB = "build_utils/jenkins_lib" + env.SH_TOOLS = "build_utils/sh" + pipeErlangService = load("${env.JENKINS_LIB}/pipeErlangService.groovy") + } + + pipeErlangService.runPipe(true, true) +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2bb9ad2 --- /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 \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d306926 --- /dev/null +++ b/Makefile @@ -0,0 +1,77 @@ +REBAR := $(shell which rebar3 2>/dev/null || which ./rebar3) +SUBMODULES = build_utils +SUBTARGETS = $(patsubst %,%/.git,$(SUBMODULES)) + +UTILS_PATH := build_utils +TEMPLATES_PATH := . + +# Name of the service +SERVICE_NAME := limiter +# Service image default tag +SERVICE_IMAGE_TAG ?= $(shell git rev-parse HEAD) +# The tag for service image to be pushed with +SERVICE_IMAGE_PUSH_TAG ?= $(SERVICE_IMAGE_TAG) + +# Base image for the service +BASE_IMAGE_NAME := service-erlang +BASE_IMAGE_TAG := 54a794b4875ad79f90dba0a7708190b3b37d584f + +# Build image tag to be used +BUILD_IMAGE_NAME := build-erlang +BUILD_IMAGE_TAG := 491bc06c745a07c6fe9e8b5dbbe958e8e0b82c4c + +CALL_ANYWHERE := all submodules rebar-update compile xref lint dialyze \ + release clean distclean check format check_format + +CALL_W_CONTAINER := $(CALL_ANYWHERE) test + +all: compile + +-include $(UTILS_PATH)/make_lib/utils_container.mk +-include $(UTILS_PATH)/make_lib/utils_image.mk + +.PHONY: $(CALL_W_CONTAINER) + +# CALL_ANYWHERE +$(SUBTARGETS): %/.git: % + git submodule update --init $< + touch $@ + +submodules: $(SUBTARGETS) + +rebar-update: + $(REBAR) update + +compile: submodules rebar-update + $(REBAR) compile + +xref: submodules + $(REBAR) xref + +lint: + elvis rock + +check_format: + $(REBAR) fmt -c + +format: + $(REBAR) fmt -w + +dialyze: + $(REBAR) dialyzer + +check: xref lint dialyze + +release: distclean + $(REBAR) as prod release + +clean: + $(REBAR) clean + +distclean: + $(REBAR) clean + rm -rf _build + +# CALL_W_CONTAINER +test: submodules + $(REBAR) ct diff --git a/README.md b/README.md new file mode 100644 index 0000000..d385077 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# limiter +Service for limits calculating diff --git a/apps/limiter/src/limiter.app.src b/apps/limiter/src/limiter.app.src new file mode 100644 index 0000000..13d83dc --- /dev/null +++ b/apps/limiter/src/limiter.app.src @@ -0,0 +1,18 @@ +{application, limiter, [ + {description, "Proto limiter service"}, + {vsn, "1.0.0"}, + {registered, []}, + {applications, [ + kernel, + stdlib, + damsel, + woody, + how_are_you, % must be after ranch and before any woody usage + scoper, % should be before any scoper event handler usage + erl_health, + prometheus, + prometheus_cowboy + ]}, + {mod, {limiter, []}}, + {env, []} +]}. diff --git a/config/sys.config b/config/sys.config new file mode 100644 index 0000000..00510dd --- /dev/null +++ b/config/sys.config @@ -0,0 +1,96 @@ +[ + {limiter, [ + {ip, "::"}, + {port, 8022}, + {services, #{ + limiter => #{ + path => <<"/v1/limiter">> + }, + configurator => #{ + path => <<"/v1/configurator">> + } + }}, + {service_clients, #{ + accounter => #{ + url => <<"http://shumway:8022/accounter">> + } + }}, + {protocol_opts, #{ + % How much to wait for another request before closing a keepalive connection? (ms) + request_timeout => 5000, + % Should be greater than any other timeouts + idle_timeout => infinity + }}, + {transport_opts, #{ + % Maximum number of simultaneous connections. (default = 1024) + max_connections => 8000, + % Size of the acceptor pool. (default = 10) + num_acceptors => 100 + }}, + % How much to wait for outstanding requests completion when asked to shut down? (ms) + {shutdown_timeout, 1000}, + + {woody_event_handlers, [ + hay_woody_event_handler, + {scoper_woody_event_handler, #{ + event_handler_opts => #{ + formatter_opts => #{ + max_length => 1000, + max_printable_string_length => 80 + } + } + }} + ]}, + + {health_check, #{ + % disk => {erl_health, disk , ["/", 99]}, + % memory => {erl_health, cg_memory, [99]}, + % service => {erl_health, service , [<<"limiter">>]} + }} + ]}, + + {kernel, [ + {logger_sasl_compatible, false}, + {logger_level, debug}, + {logger, [ + {handler, default, logger_std_h, #{ + level => error, + config => #{ + type => standard_error + }, + formatter => {logger_formatter, #{ + depth => 30 + }} + }}, + {handler, console, logger_std_h, #{ + config => #{ + type => {file, "/var/log/limiter/log.json"} + }, + formatter => {logger_logstash_formatter, #{}} + }} + ]} + ]}, + + % {how_are_you, [ + % {metrics_publishers, [ + % % {hay_statsd_publisher, #{ + % % key_prefix => <<"limiter.">>, + % % host => "localhost", + % % port => 8125 + % % }} + % ]} + % ]}, + + {os_mon, [ + % for better compatibility with busybox coreutils + {disksup_posix_only, true} + ]}, + + {scoper, [ + {storage, scoper_storage_logger} + ]}, + + {prometheus, [ + {collectors, [default]} + ]} +]. diff --git a/config/vm.args b/config/vm.args new file mode 100644 index 0000000..cd2c15b --- /dev/null +++ b/config/vm.args @@ -0,0 +1,3 @@ +-sname limiter + +-setcookie limiter_cookie \ No newline at end of file diff --git a/docker-compose.sh b/docker-compose.sh new file mode 100755 index 0000000..91f111b --- /dev/null +++ b/docker-compose.sh @@ -0,0 +1,45 @@ +#!/bin/bash +cat < ["apps/*/src"], + filter => "*.erl", + rules => [ + {elvis_style, line_length, #{limit => 120, skip_comments => false}}, + {elvis_style, no_tabs}, + {elvis_style, no_trailing_whitespace}, + {elvis_style, macro_module_names}, + {elvis_style, operator_spaces, #{rules => [{right, ","}, {right, "++"}, {left, "++"}]}}, + {elvis_style, nesting_level, #{level => 3}}, + {elvis_style, god_modules, #{limit => 25}}, + {elvis_style, no_if_expression}, + {elvis_style, invalid_dynamic_call, #{ignore => [elvis]}}, + {elvis_style, used_ignored_variable}, + {elvis_style, no_behavior_info}, + {elvis_style, module_naming_convention, #{regex => "^([a-z][a-z0-9]*_?)*(_SUITE)?$"}}, + {elvis_style, function_naming_convention, #{regex => "^([a-z][a-z0-9]*_?)*$"}}, + {elvis_style, state_record_and_type}, + {elvis_style, no_spec_with_records}, + {elvis_style, dont_repeat_yourself, #{min_complexity => 10}}, + {elvis_style, no_debug_call, #{ignore => [elvis, elvis_utils]}} + ] + }, + #{ + dirs => ["apps/*/test"], + filter => "*.erl", + rules => [ + {elvis_style, line_length, #{limit => 120, skip_comments => false}}, + {elvis_style, no_tabs}, + {elvis_style, no_trailing_whitespace}, + {elvis_style, macro_module_names}, + {elvis_style, operator_spaces, #{rules => [{right, ","}, {right, "++"}, {left, "++"}]}}, + {elvis_style, nesting_level, #{level => 3}}, + {elvis_style, god_modules, #{limit => 25}}, + {elvis_style, no_if_expression}, + {elvis_style, invalid_dynamic_call, #{ignore => [elvis]}}, + {elvis_style, used_ignored_variable}, + {elvis_style, no_behavior_info}, + {elvis_style, module_naming_convention, #{regex => "^([a-z][a-z0-9]*_?)*(_SUITE)?$"}}, + {elvis_style, function_naming_convention, #{regex => "^([a-z][a-z0-9]*_?)*$"}}, + {elvis_style, state_record_and_type}, + {elvis_style, no_spec_with_records}, + {elvis_style, dont_repeat_yourself, #{min_complexity => 10}}, + {elvis_style, no_debug_call, #{ignore => [elvis, elvis_utils]}} + ] + }, + #{ + dirs => ["."], + filter => "Makefile", + ruleset => makefiles + }, + #{ + dirs => ["."], + filter => "elvis.config", + ruleset => elvis_config + }, + #{ + dirs => ["."], + filter => "rebar.config", + rules => [ + {elvis_style, line_length, #{limit => 120, skip_comments => false}}, + {elvis_style, no_tabs}, + {elvis_style, no_trailing_whitespace} + ] + }, + #{ + dirs => ["."], + filter => "rebar.config", + rules => [ + {elvis_style, line_length, #{limit => 120, skip_comments => false}}, + {elvis_style, no_tabs}, + {elvis_style, no_trailing_whitespace} + ] + }, + #{ + dirs => ["src"], + filter => "*.app.src", + rules => [ + {elvis_style, line_length, #{limit => 120, skip_comments => false}}, + {elvis_style, no_tabs}, + {elvis_style, no_trailing_whitespace} + ] + } + ]} + ]} +]. diff --git a/rebar.config b/rebar.config new file mode 100644 index 0000000..ad1f9d3 --- /dev/null +++ b/rebar.config @@ -0,0 +1,121 @@ +%% Common project erlang options. +{erl_opts, [ + % mandatory + debug_info, + warnings_as_errors, + warn_export_all, + warn_missing_spec, + warn_untyped_record, + warn_export_vars, + + % by default + warn_unused_record, + warn_bif_clash, + warn_obsolete_guard, + warn_unused_vars, + warn_shadow_vars, + warn_unused_import, + warn_unused_function, + warn_deprecated_function + + % at will + % bin_opt_info + % no_auto_import + % warn_missing_spec_all +]}. + +%% Common project dependencies. +{deps, [ + {damsel, + {git, "https://github.com/rbkmoney/damsel.git", + {branch, "release/erlang/master"} + } + }, + {erl_health, + {git, "https://github.com/rbkmoney/erlang-health.git", + {branch, "master"}} + }, + {genlib , + {git, "https://github.com/rbkmoney/genlib.git", + {branch, "master"}} + }, + {scoper, + {git, "https://github.com/rbkmoney/scoper.git", + {branch, "master"}} + }, + {how_are_you, + {git, "https://github.com/rbkmoney/how_are_you.git", + {branch, "master"}} + }, + {woody, + {git, "https://github.com/rbkmoney/woody_erlang.git", + {branch, "master"}} + }, + {prometheus, "4.6.0"}, + {prometheus_cowboy, "0.1.8"} +]}. + + +%% XRef checks +{xref_checks, [ + undefined_function_calls, + undefined_functions, + deprecated_functions_calls, + deprecated_functions +]}. + +%% Tests +{cover_enabled, true}. + +%% Dialyzer static analyzing +{dialyzer, [ + {warnings, [ + % mandatory + unmatched_returns, + error_handling, + race_conditions, + unknown + % hardcore mode + % overspecs, + % underspecs + ]}, + {plt_apps, all_deps} +]}. + +{profiles, [ + {prod, [ + {deps, [ + {logger_logstash_formatter, + {git, "https://github.com/rbkmoney/logger_logstash_formatter.git", + {ref, "87e52c755"}} + }, + % for introspection on production + {recon, "2.3.2"} + ]}, + {relx, [ + {release, {limiter, "1.0.0"}, [ + {recon, load}, % tools for introspection + {runtime_tools, load}, % debugger + {tools, load}, % profiler + {logger_logstash_formatter, load}, % log formatter + sasl, + limiter + ]}, + {sys_config, "./config/sys.config"}, + {vm_args, "./config/vm.args"}, + {mode, minimal}, + {extended_start_script, true} + ]} + ]} +]}. + +{plugins, [ + {erlfmt, "0.8.0"}, + {rebar3_thrift_compiler, + {git, "https://github.com/rbkmoney/rebar3_thrift_compiler.git", {tag, "0.3.1"}}} +]}. + +{erlfmt, [ + {print_width, 120}, + {files, "apps/*/{src,include,test}/*.{hrl,erl}"} +]}.