From 8c08d15058285a931b327994cdd17f22139ef303 Mon Sep 17 00:00:00 2001 From: Konstantin Yarovoy Date: Fri, 27 Sep 2024 07:59:18 +0000 Subject: [PATCH 1/2] ameba: Remove ameba from shard dependencies Ameba is a linting tool, which isn't being used in our CI pipelines, and causes complications with crystal version update. Ameba dependency should be removed from cnf-testcatalog shards and usage guidelines should point to more independent usage via installing the linter from source. Refs: #2157 Signed-off-by: Konstantin Yarovoy --- USAGE.md | 11 +++++++---- shard.lock | 4 ---- shard.yml | 5 ----- 3 files changed, 7 insertions(+), 13 deletions(-) diff --git a/USAGE.md b/USAGE.md index efeaa477a..19b9051a2 100644 --- a/USAGE.md +++ b/USAGE.md @@ -171,15 +171,18 @@ CNF_TESTSUITE_LITMUS_CHAOS_TEST_TIMEOUT=1800 CNF_TESTSUITE_NODE_DRAIN_TOTAL_CHAOS_DURATION=90 ``` -#### Running The Linter in Developer Mode +#### Running The Linter -See https://github.com/crystal-ameba/ameba for more details. Follow the [INSTALL](INSTALL.md) guide starting at the [Source Install](INSTALL.md#source-install) for more details running cnf-testsuite in developer mode. +Ameba (https://github.com/crystal-ameba/ameba) is a static code linter for crystal-lang. +To run Ameba, you need to install testsuite in developer mode ([Source Install](INSTALL.md#source-install)) and use installation from source method for Ameba, which is mentioned in Ameba readme.md: ``` -shards install # only for first install -crystal bin/ameba.cr +git clone https://github.com/crystal-ameba/ameba && cd ameba +make install ``` +After that, follow the usage guidelines from the Ameba repository. + ### Usage for categories and single tests It's located in [TEST_DOCUMENTATION](docs/TEST_DOCUMENTATION.md), Check for needed category or test there. diff --git a/shard.lock b/shard.lock index 2a92e7662..9570c5516 100644 --- a/shard.lock +++ b/shard.lock @@ -1,9 +1,5 @@ version: 2.0 shards: - ameba: - git: https://github.com/crystal-ameba/ameba.git - version: 1.3.1 - cluster_tools: git: https://github.com/cnf-testsuite/cluster_tools.git version: 1.0.7 diff --git a/shard.yml b/shard.yml index fc66cea37..47062e7b0 100644 --- a/shard.yml +++ b/shard.yml @@ -73,9 +73,4 @@ dependencies: protobuf: github: jeromegn/protobuf.cr -development_dependencies: - ameba: - github: crystal-ameba/ameba - version: ~> 1.3.1 - license: MIT From d22b548f0c43951003091f6092933bdea6c7c278 Mon Sep 17 00:00:00 2001 From: Martin Matyas Date: Tue, 1 Oct 2024 16:29:31 +0200 Subject: [PATCH 2/2] Update USAGE.md Signed-off-by: Martin Matyas --- USAGE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/USAGE.md b/USAGE.md index 19b9051a2..4fe382f8f 100644 --- a/USAGE.md +++ b/USAGE.md @@ -174,7 +174,7 @@ CNF_TESTSUITE_NODE_DRAIN_TOTAL_CHAOS_DURATION=90 #### Running The Linter Ameba (https://github.com/crystal-ameba/ameba) is a static code linter for crystal-lang. -To run Ameba, you need to install testsuite in developer mode ([Source Install](INSTALL.md#source-install)) and use installation from source method for Ameba, which is mentioned in Ameba readme.md: +To run Ameba, testsuite needs to be installed in developer mode ([Source Install](INSTALL.md#source-install)) and Ameba needs to be installed using source method, which is mentioned in Ameba readme.md: ``` git clone https://github.com/crystal-ameba/ameba && cd ameba