Modernize

Author: simeg

.github/workflows/ci.yaml

@@ -1,20 +1,27 @@
 name: CI
 
-on: push
+on:
+  push:
+  pull_request:
 
 jobs:
   ci:
     name: CI
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
+
+    - name: Setup Bats and bats libs
+      uses: bats-core/bats-action@3.0.0
 
     - name: CI Bash
       run: make ci-bash
 
-    - name: CI Python
-      uses: actions/setup-python@v2
+    - name: Set up Python
+      uses: actions/setup-python@v5
       with:
         python-version: '3.x'
-    - run: make ci-py
+    
+    - name: CI Python
+      run: make ci-py

Makefile

@@ -1,4 +1,4 @@
-.PHONY: fmt format lint test
+.PHONY: fmt format lint test update-sha256 clean ci-bash install install-bats local-install ci-py install-py-deps it-test local-install-ci setup
 
 ### Bash
 
@@ -7,49 +7,59 @@ clean:
 	rm /usr/local/bin/filter
 	rm -rf /usr/local/lib/fs
 
-ci-bash: lint install-bats test
+ci-bash: lint test
 
 fmt: format
 
 format:
-	shellcheck -x -f diff fs/operations/* | git apply
-	shellcheck -x -f diff map | git apply
-	shellcheck -x -f diff filter | git apply
+	shellcheck -x -f diff fs/operations/* | git apply --allow-empty
+	shellcheck -x -f diff
+	shellcheck -x -f diff filter | git apply --allow-empty
 
 install:
 	./install.sh
 
-install-bats:
-	git clone https://github.com/bats-core/bats-core.git /tmp/bats-core && \
-		cd /tmp/bats-core && \
-		sudo ./install.sh /usr/local
-
-local-install:
-	@cp -f ./map /usr/local/bin/
-	@cp -f ./filter /usr/local/bin/
-	@cp -rf ./fs /usr/local/lib/
-
 lint:
 	shellcheck -x -e SC1091 map
 	shellcheck -x -e SC1091 filter
 	shellcheck -x fs/operations/*
 	shellcheck -x fs/functions/*
+	shellcheck -x install.sh
+	shellcheck -x update-sha256.sh
+	shellcheck -x it-test-setup.sh
+
+setup:
+	@echo "Setting up the environment..."
+	@brew install shellcheck bats parallel
 
 test:
 	bats -j 15 tests/
 
+update-sha256:
+	./update-sha256.sh
+
 
 ### Python
 
 ci-py: install-py-deps local-install-ci it-test
 
+setup-py:
+	poetry env use python3.11
+
 install-py-deps:
-	pip install -r tests/integration-tests/requirements.txt
+	poetry install --only=test
 
-it-test:
-	pytest -s tests/integration-tests/tests.py
+it-test: it-test-install
+	poetry run pytest -s tests/integration-tests/tests.py
+	./it-test-setup.sh uninstall
 
 local-install-ci:
 	sudo cp -f ./map /usr/local/bin/
 	sudo cp -f ./filter /usr/local/bin/
 	sudo cp -rf ./fs /usr/local/lib/
+
+it-test-install:
+	./it-test-setup.sh install
+
+it-test-uninstall:
+	./it-test-setup.sh uninstall

fs/fs

@@ -0,0 +1 @@
+/Users/segersand/Documents/Personal/repos_personal/functional-shell/fs

fs/functions/_filter

@@ -61,9 +61,11 @@ function _filter {
 
   local filter_res
   while read -r line; do
-    filter_res=$(eval "$fn_arg" "'$line'" "'$args'")
-    if [ "$filter_res" == "true" ]; then
-      printf "%s\n" "$line"
+    # Use safer function call instead of eval
+    if filter_res=$("$fn_arg" "$line" "$args"); then
+      if [ "$filter_res" == "true" ]; then
+        printf "%s\n" "$line"
+      fi
     fi
   done < /dev/stdin
 

fs/functions/_map

@@ -7,6 +7,12 @@ function _map {
   shift
   local args="$*"
 
+  # Validate function name contains only safe characters
+  if [[ ! "$fn_arg" =~ ^[a-zA-Z_][a-zA-Z0-9_]*$ ]]; then
+    printf "Error: Invalid function name '%s' for map\n" "$fn_arg" >&2
+    exit 1
+  fi
+
   if [ "$(declare -f "$fn_arg" > /dev/null; echo $?)" -gt 0 ]; then
     printf "%s %s\n" "$fn_arg" "is not a valid function for map" >&2
     exit 1
@@ -22,7 +28,8 @@ function _map {
   IFS=''
 
   while read -r line; do
-    eval "$fn_arg" "'$line'" "'$args'"
+    # Use safer function call instead of eval
+    "$fn_arg" "$line" "$args"
   done < /dev/stdin
 
   IFS=$old_ifs

fs/operations/file_and_dir

@@ -97,7 +97,11 @@ function has_ext {
     printf "%s\n" false
   else
     local has_ext
-    has_ext=$(test "$input" != "$actual_ext"; echo $?)
+    if test "$input" != "$actual_ext"; then
+      has_ext=0
+    else
+      has_ext=1
+    fi
     local has_same_ext
     has_same_ext=$(test "$actual_ext" == "$expected_ext"; echo $?)
 

fs/operations/string

@@ -33,7 +33,7 @@ function substr {
 
   local i=0
   for arg in $args; do
-    split_args[$i]="$arg"
+    split_args[i]="$arg"
     i=$((i + 1))
   done
 
@@ -74,7 +74,7 @@ function replace {
 
   local i=0
   for arg in $args; do
-    split_args[$i]="$arg"
+    split_args[i]="$arg"
     i=$((i + 1))
   done
 

install.sh

@@ -7,25 +7,70 @@
 # finally removes the cloned repo
 #
 
-set -e
+set -euo pipefail
 
 readonly tmp_dir="/tmp/functional-shell"
+readonly repo_url="https://github.com/simeg/functional-shell"
+readonly expected_sha256="160a085aa649b90a55c704e8a46c1d8c73241fc88fae62f0095baadece0f3c32"
 
+# Check if we need sudo for installation
+check_permissions() {
+    if [[ ! -w /usr/local/bin ]] || [[ ! -w /usr/local/lib ]]; then
+        echo "-- Root permissions required for installation to /usr/local"
+        if command -v sudo >/dev/null 2>&1; then
+            echo "-- Will use sudo for installation"
+            USE_SUDO="sudo"
+        else
+            echo "-- Error: No write permissions and sudo not available" >&2
+            exit 1
+        fi
+    else
+        USE_SUDO=""
+    fi
+}
+
+# Verify repository integrity
+verify_integrity() {
+    echo "-- Verifying repository integrity..."
+    
+    if [[ "${expected_sha256}" == "PLACEHOLDER_SHA256" ]]; then
+        echo "-- Warning: Checksum verification disabled (no expected hash provided)"
+        return 0
+    fi
+    
+    # Calculate SHA256 of the git tree
+    local actual_sha256
+    actual_sha256=$(cd "${tmp_dir}" && git ls-tree HEAD | sha256sum | cut -d' ' -f1)
+    
+    if [[ "${actual_sha256}" != "${expected_sha256}" ]]; then
+        echo "-- Error: Repository integrity check failed!" >&2
+        echo "-- Expected: ${expected_sha256}" >&2
+        echo "-- Actual:   ${actual_sha256}" >&2
+        echo "-- This could indicate tampering or an unexpected version" >&2
+        exit 1
+    fi
+    
+    echo "-- Repository integrity verified ✓"
+}
 
 echo "-- Cloning repo..."
 
-git clone https://github.com/simeg/functional-shell ${tmp_dir}
+git clone "${repo_url}" "${tmp_dir}"
 
 echo "-- Repo cloned!"
 
+verify_integrity
+
+check_permissions
+
 echo "-- Installing..."
 
 # Install map and filter
-cp -f ${tmp_dir}/map /usr/local/bin
-cp -f ${tmp_dir}/filter /usr/local/bin
+${USE_SUDO} cp -f "${tmp_dir}/map" /usr/local/bin/
+${USE_SUDO} cp -f "${tmp_dir}/filter" /usr/local/bin/
 
 # Install operations
-cp -rf ${tmp_dir}/fs /usr/local/lib
+${USE_SUDO} cp -rf "${tmp_dir}/fs" /usr/local/lib/
 
 echo "-- Cleaning up temp files..."
 

it-test-setup.sh

@@ -0,0 +1,68 @@
+#!/usr/bin/env bash
+
+#
+# Integration test setup script using symlinks
+# This allows running it-test without needing sudo or copying files
+#
+# Usage: ./it-test-setup.sh [install|uninstall]
+#
+
+set -euo pipefail
+
+script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+readonly script_dir
+readonly bin_dir="$HOME/.local/bin"
+readonly lib_dir="$HOME/.local/lib"
+
+usage() {
+    echo "Usage: $0 [install|uninstall]"
+    echo "  install   - Create symlinks for integration testing"
+    echo "  uninstall - Remove symlinks created for integration testing"
+    exit 1
+}
+
+install_symlinks() {
+    echo "-- Setting up symlinks for integration testing..."
+    
+    # Ensure directories exist
+    mkdir -p "$bin_dir" "$lib_dir"
+    
+    # Create symlinks for executables
+    ln -sf "$script_dir/map" "$bin_dir/map"
+    ln -sf "$script_dir/filter" "$bin_dir/filter"
+    
+    # Create symlink for operations library
+    ln -sf "$script_dir/fs" "$lib_dir/fs"
+    
+    echo "-- Symlinks created:"
+    echo "   $bin_dir/map -> $script_dir/map"
+    echo "   $bin_dir/filter -> $script_dir/filter"
+    echo "   $lib_dir/fs -> $script_dir/fs"
+    echo ""
+    echo "-- Make sure $bin_dir is in your PATH:"
+    echo "   export PATH=\"\$HOME/.local/bin:\$PATH\""
+}
+
+uninstall_symlinks() {
+    echo "-- Removing symlinks for integration testing..."
+    
+    # Remove symlinks if they exist
+    [ -L "$bin_dir/map" ] && rm "$bin_dir/map" && echo "   Removed $bin_dir/map"
+    [ -L "$bin_dir/filter" ] && rm "$bin_dir/filter" && echo "   Removed $bin_dir/filter"
+    [ -L "$lib_dir/fs" ] && rm "$lib_dir/fs" && echo "   Removed $lib_dir/fs"
+    
+    echo "-- Symlinks removed"
+}
+
+# Parse command line argument
+case "${1:-install}" in
+    install)
+        install_symlinks
+        ;;
+    uninstall)
+        uninstall_symlinks
+        ;;
+    *)
+        usage
+        ;;
+esac