added standalone pylint.sh script; improved install-build-tools.sh ov…

…er prev commit Signed-off-by: Morgan Rockett <[email protected]>
rockett-m · Jun 15, 2024 · 699f0ba · 699f0ba
1 parent 7323f53
commit 699f0ba
Show file tree

Hide file tree

Showing 5 changed files with 135 additions and 59 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -30,7 +30,7 @@ jobs:
       - name: Setup Local Dependencies
         run: ./scripts/setup-dependencies.sh
       - name: Build
-        run: scripts/build.sh
+        run: ./scripts/build.sh
   lint:
     name: Lint
     runs-on: ubuntu-20.04
@@ -43,16 +43,17 @@ jobs:
       - name: Setup Local Dependencies
         run: ./scripts/setup-dependencies.sh
       - name: Build
-        run: scripts/build.sh
+        run: ./scripts/build.sh
       - name: Lint
-        run: scripts/lint.sh
+        run: ./scripts/lint.sh
   pylint:
     name: Pylint
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     continue-on-error: true
-    timeout-minutes: 5
+    timeout-minutes: 10
     strategy:
       matrix:
+        # pylint is not supported on python 3.13 yet
         python-version: ["3.10", "3.11", "3.12"]
     steps:
       - uses: actions/checkout@v2
@@ -62,15 +63,13 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          python3 -m pip install --upgrade pip
-          if [ -f requirements_py.txt ]; then pip install -r requirements_py.txt; fi
-          pip install pylint
+      - name: Setup Build Env
+        run: sudo ./scripts/install-build-tools.sh
       - name: Lint with Pylint
         run: |
-          # In the future we should have (minimum score of 8.0/10.0 or 9.0/10.0)
-          pylint --rcfile=.pylintrc $(git ls-files '*.py') --fail-under=5.0
+          set -x
+          MIN_CODE_QUALITY=5.0
+          ./scripts/pylint.sh $MIN_CODE_QUALITY
   unit-and-integration-test:
     name: Unit and Integration Tests
     runs-on: ubuntu-20.04
@@ -84,9 +83,9 @@ jobs:
       - name: Setup Local Dependencies
         run: ./scripts/setup-dependencies.sh
       - name: Build
-        run: scripts/build.sh
+        run: ./scripts/build.sh
       - name: Run Unit Tests
-        run: scripts/test.sh
+        run: ./scripts/test.sh
       - name: Shorten SHA
         id: vars
         run: echo "::set-output name=sha_short::$(git rev-parse --short HEAD)"

diff --git a/.gitignore b/.gitignore
@@ -47,7 +47,6 @@ ethash*/
 lua-*/
 benchmark-results/
 CMakeFiles/
-Python-*/
 plots/
 .deps/
 .libs/

diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@ There are two UHS-based architectures as follows:
    - Maximum demonstrated throughput ~1.7M transactions per second.
    - Geo-replicated latency <1 second.
 
-Read the [2PC &amp; Atomizer architecture guide](docs/uhs-architectures.md) for a detailed description of the system components and implementation of each architecture.
+Read the [2PC & Atomizer architecture guide](docs/uhs-architectures.md) for a detailed description of the system components and implementation of each architecture.
 
 ## Parallel Architecture for Scalably Executing smart Contracts ("PArSEC")
 
@@ -86,8 +86,9 @@ If you just want to run the system, see "Run the Code" below.
 1. Setup the build-environment.
    Note that this script is just a convenience to install system-wide dependencies we expect.
    As a result, it uses the system package manager, requires `sudo`, and should only be run **once**.
+   Note: Running Homebrew as root on mac is not supported.
    ```console
-   ./scripts/install-build-tools.sh
+   sudo ./scripts/install-build-tools.sh
    ```
 2. Setup project dependencies
    This script builds and installs a local copy of several build-dependencies which are not widely packaged.
@@ -116,7 +117,7 @@ See the [live deployment](https://mit-dci.github.io/opencbdc-tx-pages/) to brows
 
 ## UHS-based Architectures (2PC & Atomizer)
 
-See the [2PC &amp; Atomizer User Guide](docs/2pc_atomizer_user_guide.md)
+See the [2PC & Atomizer User Guide](docs/2pc_atomizer_user_guide.md)
 
 ## PArSEC Architecture
 
@@ -159,7 +160,7 @@ Review results and logs at `testruns/<testrun-uuid>/`
 ## Linting
 
 ### General
-This script checks for newlines at the end of files. 
+This script checks for newlines at the end of all tracked git files except images. 
 Then it runs clang-format and clang-tidy on `.cpp` files in the following directories:
  `src`, `tests`, `cmake-tests`, `tools`.
 ```console
@@ -168,6 +169,7 @@ Then it runs clang-format and clang-tidy on `.cpp` files in the following direct
 
 ### Python
 Lint all python files according to ruleset defined in `.pylintrc`.
+Optional code quality value >= 5.0 and <= 10.0 can be entered as a threshold of failure.
 ```console
-pylint --rcfile=.pylintrc $(git ls-files '*.py') --fail-under=8.0
+./scripts/pylint.sh 8.0
 ```
diff --git a/scripts/install-build-tools.sh b/scripts/install-build-tools.sh
@@ -6,48 +6,61 @@ green="\033[0;32m"
 cyan="\033[0;36m"
 end="\033[0m"
 
-set -e
+# for debugging, 'set -x' can be added to trace the commands
+set -ex
 
 SUDO=''
 if (( $EUID != 0 )); then
     echo -e "non-root user, sudo required"
     SUDO='sudo'
 fi
 
-# Function to check if a version of Python >= 3.10 is installed
-check_python_version() {
-  if command -v python3 &>/dev/null; then
-    # Get the version of Python
-    PYTHON_VERSION=$(python3 --version | awk '{print $2}')
-    IFS='.' read -r -a version_parts <<< "$PYTHON_VERSION"
-    echo "Python version: ${version_parts[0]}.${version_parts[1]}"
-    # >= 3.10
-    if (( ${version_parts[0]} >= 3 && ${version_parts[1]} >= 10 )); then
-      return 0
-    fi
-  fi
-  return 1
-}
+# as of June 2024, python3.13 does not support pylint so limiting most recent version 3.12
+PY_VERSIONS=("3.12" "3.11" "3.10")
+echo "Python3 at start of script version: $(python3 --version)"
+echo "OS Type: $OSTYPE"
 
 if [[ "$OSTYPE" == "darwin"* ]]; then
   CPUS=$(sysctl -n hw.ncpu)
   # ensure development environment is set correctly for clang
   $SUDO xcode-select -switch /Library/Developer/CommandLineTools
-  # see if homebrew is installed and install if not
-  if ! [[ -f /opt/homebrew/bin/brew ]]; then
-    echo -e "${green}Installing Homebrew...${end}"
-    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+
+  echo "Running sudo with homebrew as root through a shell script is not allowed."
+  echo "These installs can be done manually in a terminal, however."
+
+  if ! command -v brew &>/dev/null; then
+    echo -e "${cyan}Homebrew is required to install dependencies.${end}"
+    exit 1
   fi
-  export PATH="/opt/homebrew/bin:$PATH"
 
-  brew install llvm@14 googletest google-benchmark lcov make wget cmake curl bash python3 pylint python-matplotlib
+  brew install llvm@14 googletest google-benchmark lcov make wget cmake bash bc
   brew upgrade bash
 
-  # Add Python 3 to PATH
-  echo "export PATH=\"/opt/homebrew/opt/python@3/bin:\$PATH\"" >> ~/.bash_profile
-  # Make python3 default
-  echo "alias python=python3" >> ~/.bash_profile
-  . ~/.bash_profile
+  DEFAULT_PYTHON=`python3 --version | | grep -E 'Python 3.[0-9]+'`
+  # Install one of the python versions if not already installed
+  if ! (echo "${DEFAULT_PYTHON}" | grep -E 'Python 3.1[0-2]'); then
+    FOUND=false
+    for PY_VERS in "${PY_VERSIONS[@]}"; do
+      if brew search python@${PY_VERS} | grep  "python@${PY_VERS}"; then
+        echo "Python$PY_VERS is available, so installing it"
+        brew install python@${PY_VERSIONS[0]} pylint python-matplotlib
+        export PATH="$(brew --prefix python@${PY_VERS})/bin:$PATH"
+        FOUND=true
+        break
+      fi
+    done
+
+    VERSION_SHORT=`${DEFAULT_PYTHON} | grep -E -o 'Python 3.[0-9]{1,2}'`
+    echo "Python3 version: $VERSION_SHORT"
+    if [ "$FOUND" == false ]; then
+      echo "Python3 install with brew failed, attempted on these versions: ${PY_VERSIONS[@]}"
+      exit 1
+    elif [ echo "${VERSION_SHORT}" >= 3.13 ]; then
+      echo "Your Python3 default version: $DEFAULT_PYTHON is not supported by pylint yet"
+      echo "Please set default python3 to one of the versions: ${PY_VERSIONS[@]} and try again."
+      exit 1
+    fi
+  fi
 
   CLANG_TIDY=/usr/local/bin/clang-tidy
   if [ ! -L "$CLANG_TIDY" ]; then
@@ -59,28 +72,55 @@ if [[ "$OSTYPE" == "darwin"* ]]; then
   fi
 
 elif [[ "$OSTYPE" == "linux-gnu"* ]]; then
-  $SUDO apt update
-  $SUDO apt install -y build-essential wget cmake libgtest-dev libbenchmark-dev lcov git software-properties-common rsync unzip
+  # avoids getting stuck on interactive prompts which is essential for CI/CD
+  export DEBIAN_FRONTEND=noninteractive
+  $SUDO apt update -y
+  $SUDO apt install -y build-essential wget cmake libgtest-dev libbenchmark-dev \
+    lcov git software-properties-common rsync unzip bc
+
+  # Add LLVM GPG key (apt-key is deprecated in Ubuntu 21.04+ so using gpg)
+  wget -qO - https://apt.llvm.org/llvm-snapshot.gpg.key | \
+    gpg --dearmor -o /usr/share/keyrings/llvm-archive-keyring.gpg
+  echo "deb [signed-by=/usr/share/keyrings/llvm-archive-keyring.gpg] http://apt.llvm.org/focal/ llvm-toolchain-focal-14 main" | \
+    $SUDO tee /etc/apt/sources.list.d/llvm.list
 
-  wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | $SUDO apt-key add -
-  $SUDO add-apt-repository "deb http://apt.llvm.org/focal/ llvm-toolchain-focal-14 main"
+  $SUDO apt update -y
   $SUDO apt install -y clang-format-14 clang-tidy-14
   $SUDO ln -s -f $(which clang-format-14) /usr/local/bin/clang-format
   $SUDO ln -s -f $(which clang-tidy-14) /usr/local/bin/clang-tidy
 
-  # Python 3.10+ not installed so get the latest version
-  if ! check_python_version; then
-    $SUDO add-apt-repository ppa:deadsnakes/ppa
-    $SUDO apt update
+  # Install one of the python versions if not already installed
+  FOUND=false
+  if ! (python3 --version | grep -E 'Python 3.1[0-2]'); then
 
-    latest_python_version=$(apt-cache search python3. | grep -o 'python3\.[0-9]*' | sort -V | tail -n 1)
-    $SUDO apt install -y $latest_python_version
+    $SUDO add-apt-repository -y ppa:deadsnakes/ppa
+    $SUDO apt update -y
 
-    $SUDO update-alternatives --install /usr/bin/python3 python3 /usr/bin/$(ls /usr/bin/ | grep -E '^python3\.[0-9]+$' | sort -V | tail -n 1) 1
-    $SUDO update-alternatives --config python3
+    for PY_VERS in "${PY_VERSIONS[@]}"; do
+      if apt list -a python${PY_VERS}; then
+        echo "python$PY_VERS is available, so installing it"
+        $SUDO apt install -y python$PY_VERS python3-pip
+        $SUDO update-alternatives --install /usr/bin/python3 python3 /usr/bin/python$PY_VERS 1
+        $SUDO update-alternatives --config python3
+        FOUND=true
+        break
+      fi
+    done
+    if [ "$FOUND" == false ]; then
+      echo "Python3 install with apt failed, attempted on these versions: ${PY_VERSIONS[@]}"
+      exit 1
+    fi
+
+  else
+    echo "Python3 is already installed"
+    VERSION_SHORT=`${DEFAULT_PYTHON} | grep -E -o '3.[0-9]{1,2}'`
+    $SUDO apt install -y python$VERSION_SHORT python3-pip
   fi
+
+  # Install pylint and matplotlib whether python3 adequate version was found or not
+  $SUDO pip3 install pylint matplotlib
 fi
-python3 --version
+echo "Python3 version now: $(python3 --version)"
 
 PYTHON_TIDY=/usr/local/bin/run-clang-tidy.py
 if [ ! -f "${PYTHON_TIDY}" ]; then

diff --git a/scripts/pylint.sh b/scripts/pylint.sh
@@ -0,0 +1,36 @@
+#!/bin/bash
+
+# depedenent on 'sudo scripts/install-build-tools.sh' to install pylint
+if ! command -v pylint &>/dev/null; then
+  echo "pylint is not installed."
+  echo "Run 'sudo ./scripts/install-build-tools.sh' to install pylint."
+  exit 1;
+fi
+
+MIN_CODE_QUALITY=8.0
+if [ -n "$1" ]; then
+  # set minimum quality to user input (int/float) if provided and (5.0 <= input <= 10.0)
+  if [[ $1 =~ ^[0-9]*([\.][0-9])?$ ]]; then
+    if (( $(echo "$1 >= 5.0" | bc -l) )) && (( $(echo "$1 <= 10.0" | bc -l) )); then
+      MIN_CODE_QUALITY=$1
+    else
+      # In the future, we want code quality to be at minimum 8.0/10.0
+      echo "Code quality score must be between 5.0 and 10.0, inclusive."
+      echo "Recommended code quality score is >= 8.0."
+      exit 1
+    fi
+  else
+    echo "Code quality score must be an integer or floating point number."
+    exit 1
+  fi
+fi
+
+echo "Linting Python code with minimum quality of $MIN_CODE_QUALITY/10.0..."
+pylint --rcfile=.pylintrc --fail-under=$MIN_CODE_QUALITY $(git ls-files '*.py')
+
+if [ $? -ne 0 ]; then
+  echo "Linting failed, please fix the issues above."
+  exit 1
+else
+  echo "Linting passed."
+fi