Add CI, linter and license checkers (#17)

1. Add initial CI to cover lint, license check, DLC
2. Enforce coding style
3. Update dependency and provide commands to fix code smell

Author: Superskyyy

Diff for: .dlc.json

@@ -0,0 +1,16 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^http://localhost"
+    }
+  ],
+  "timeout": "10s",
+  "retryOn429": true,
+  "retryCount": 10,
+  "fallbackRetryDelay": "1000s",
+  "aliveStatusCodes": [
+    200,
+    401,
+    403
+  ]
+}

Diff for: .github/workflows/CI.yaml

@@ -0,0 +1,48 @@
+#  Copyright 2022 SkyAPM org
+#
+#  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.
+
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+  schedule:
+    - cron: '0 18 * * *'
+
+concurrency:
+  group: CI-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  license-and-lint:
+    name: License and Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source codes
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+      - name: Check License
+        uses: apache/skywalking-eyes/header@442d4621d10ae9e92a859d873e6e63664622a50d
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.10'
+      - name: Python Linters
+        run: |
+          pip install -U pip setuptools
+          pip install poetry
+          make lint

Diff for: .github/workflows/dead-link-checker.yaml

@@ -0,0 +1,42 @@
+#  Copyright 2022 SkyAPM org
+#
+#  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.
+
+# Dead link checker is always run on all files
+name: Dead Link Checker
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+  schedule:
+    - cron: '0 18 * * *'
+
+concurrency:
+  group: dlc-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  CheckDeadLinks:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    if: (github.event_name == 'schedule' && github.repository == 'SkyAPM/aiops-engine-for-skywalking') || (github.event_name != 'schedule')
+    steps:
+      - uses: actions/checkout@v3
+      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          use-quiet-mode: 'no'
+          use-verbose-mode: 'yes'
+          config-file: '.dlc.json'
+          folder-path: 'docs/'

Diff for: .gitignore

@@ -23,3 +23,5 @@ dist/
 **/*.egg-info/
 **/*venv*/
 .vscode/
+engine_protocol/
+assets/datasets

Diff for: .licenserc.yaml

@@ -0,0 +1,32 @@
+#  Copyright 2022 SkyAPM org
+#
+#  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.
+
+header:
+  license:
+    spdx-id: Apache-2.0
+    copyright-owner: SkyAPM org
+
+  paths-ignore:
+    - 'dist'
+    - '**/*.md'
+    - 'LICENSE'
+    - 'NOTICE'
+    - '.github/*_TEMPLATE'
+    - '.gitignore'
+    - '**/*.json'
+    - '**/*.ipynb'
+    - '**/*.lock'
+    - '**/*.csv'
+
+  comment: on-failure

Diff for: Makefile

@@ -0,0 +1,63 @@
+#  Copyright 2022 SkyAPM org
+#
+#  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.
+
+VERSION ?= latest
+
+# determine host platform
+VENV_DIR = .venv
+VENV = $(VENV_DIR)/bin
+ifeq ($(OS),Windows_NT)
+    VENV=./$(VENV_DIR)/Scripts
+endif
+
+$(VENV):
+	python3 -m venv $(VENV_DIR)
+	poetry run python -m pip install --upgrade pip
+
+all: gen get-dataset prune-dataset lint license clean
+
+.PHONY: all
+
+gen:
+	poetry run python -m pip install grpcio-tools
+	poetry run python -m tools.grpc_code_gen
+
+#argument indicates a dataset name defined in sample_data_manager.py
+get-dataset:
+	poetry run python -m tools.sample_data_manager download --name $(name) --save $(save)
+prune-dataset: # remove all downloaded datasets
+	poetry run python -m tools.sample_data_manager clean --purge
+
+# flake8 configurations should go to the file setup.cfg
+
+lint-setup:
+	poetry install --only linters
+
+lint: lint-setup
+	poetry run python -m flake8
+
+# fix problems described in CodingStyle.md - verify outcome with extra care
+lint-fix: lint-setup
+	$(VENV)/isort .
+	$(VENV)/unify -r --in-place .
+	$(VENV)/flynt -tc -v .
+
+# todo make this work on windows
+clean:
+	find . -name "*.egg-info" -exec rm -r {} +
+	find . -name "dist" -exec rm -r {} +
+	find . -name "build" -exec rm -r {} +
+	find . -name "__pycache__" -exec rm -r {} +
+	find . -name ".pytest_cache" -exec rm -r {} +
+	find . -name "*.pyc" -exec rm -r {} +

Diff for: docs/en/contribute/CodingStyle.md

@@ -0,0 +1,58 @@
+# Coding Style for the SkyWalking AIOps Engine
+
+## String formatting
+
+Since Python 3.5 is end of life, we fully utilize the clarity and performance boost brought
+by [f-strings](https://docs.python.org/3/reference/lexical_analysis.html#f-strings).
+Please do not use other styles - `+`, `%` or `.format` unless f-string is absolutely unfeasible in the context, or
+it is a logger message, which is [optimized](https://docs.python.org/3/howto/logging.html#optimization) for the `%`
+style
+
+Run `make lint-fix` to invoke [flynt](https://github.com/ikamensh/flynt) to convert other formats to f-string, pay **
+extra care** to possible corner
+cases leading to a semantically different conversion.
+
+### Quotes
+
+As we know both single quotes and double quotes are both acceptable in Python.
+For a better coding style, we enforce a check for using single quotes when possible.
+
+Please only use double quotes on the outside when there are inevitable single quotes inside the string, or when there
+are nest quotes.
+
+For example -
+
+```python
+foo = f"I'm a string"
+bar = f"This repo is called 'skywalking-python'"
+```
+
+Run `make lint-fix` to invoke [unify](https://github.com/myint/unify) to deal with your quotes if flake8 complaints
+about it.
+
+## Debug messages
+
+Please import the `logger_debug_enabled` variable and wrap your debug messages with a check.
+
+This should be done for all performance critical components.
+
+```python
+if logger_debug_enabled:
+    logger.debug('Message - %s', some_func())
+```
+
+# Imports
+
+Please make sure the imports are placed in a good order, or flake8-isort will notify you of the violations.
+
+Run `make lint-fix` to automatically fix the sorting problem.
+
+# Naming
+
+In PEP8 convention, we are required to use snake_case as the accepted style.
+
+However, there are special cases. For example, you are overriding/monkey-patching a method which happens to use the old
+style camelCase naming,
+then it is acceptable to have the original naming convention to preserve context.
+
+Please mark the line with `# noqa` to avoid linting.

Diff for: engine/models/__init__.py

@@ -0,0 +1,25 @@
+#  Copyright 2022 SkyAPM org
+#
+#  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.
+#
+#  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.

Diff for: engine/models/metric/base/__init__.py

@@ -1,4 +1,29 @@
-from .detector import BaseDetector
+#  Copyright 2022 SkyAPM org
+#
+#  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.
+#
+#  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.
 
+from .detector import BaseDetector
 
-__all__ = ["BaseDetector"]
+__all__ = ['BaseDetector']

Diff for: engine/models/metric/base/detector.py

@@ -1,37 +1,59 @@
+#  Copyright 2022 SkyAPM org
+#
+#  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.
+#
+#  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.
+
 from abc import ABC, abstractmethod
 from typing import Union
-from datetime import datetime
-from dateutil.parser import parse
-import numpy as np
+
 
 class BaseDetector(ABC):
-    """Abstract class for Detector, supporting for customize detector."""
+    """Abstract class for Detector, supporting for customize detectors."""
 
     def __init__(self):
         """Initialization BaseDetector"""
-        self.data_type = "multivariate"
+        self.data_type = 'multivariate'
         self.index = -1
         self.window_len = 100
 
     def _check(self, timestamp: str, X: Union[float, int]) -> bool:
-        """Check whether the detector can handle the data."""
+        """Check whether the detectors can handle the data."""
 
         assert type(X) in [
             float,
             int
-        ], "Please input X with float or int type."
+        ], 'Please input X with float or int type.'
         assert type(timestamp)
 
         self.index += 1
 
     @abstractmethod
     def fit(self, X: float):
-
         return NotImplementedError
 
     @abstractmethod
     def score(self, X: float) -> float:
-
         return NotImplementedError
 
     def fit_score(self, timestamp: str, X: Union[float, int]) -> float: