|
| 1 | +#!/bin/bash |
| 2 | + |
| 3 | +echo "********************************" |
| 4 | +echo "Running feature flag checks" |
| 5 | +echo "********************************" |
| 6 | + |
| 7 | +failed_checks=0 |
| 8 | + |
| 9 | +function item_in_array() { |
| 10 | + local item="$1" |
| 11 | + shift |
| 12 | + local array=("$@") |
| 13 | + |
| 14 | + for element in "${array[@]}"; do |
| 15 | + if [[ "$element" == "$item" ]]; then |
| 16 | + echo 1 |
| 17 | + return |
| 18 | + fi |
| 19 | + done |
| 20 | + |
| 21 | + echo 0 |
| 22 | +} |
| 23 | + |
| 24 | +function get_classes_from_constants_file() { |
| 25 | + # Get the file path of the FeatureFlagConstants File |
| 26 | + file_path=$(find . -name FeatureFlagConstants.kt) |
| 27 | + |
| 28 | + # Get a list of feature flag annotation classes |
| 29 | + annotation_classes=$(grep -E '[\s\w]*annotation\s*class' "$file_path") |
| 30 | + |
| 31 | + # Convert the string into an array, splitting by newline |
| 32 | + IFS=$'\n' read -rd '' -a array <<<"$annotation_classes" |
| 33 | + |
| 34 | + # Create an empty array to hold individual class names |
| 35 | + class_names=() |
| 36 | + |
| 37 | + # Iterate through each line and take the last word of the list |
| 38 | + for line in "${array[@]}"; do |
| 39 | + # Convert each line into an array of words, splitting by space |
| 40 | + IFS=' ' read -ra words <<<"$line" |
| 41 | + |
| 42 | + # Get last element of the list |
| 43 | + last_element="${words[${#words[@]}-1]}" |
| 44 | + |
| 45 | + # Add the element into class_names |
| 46 | + class_names+=("$last_element") |
| 47 | + done |
| 48 | + |
| 49 | + echo "${class_names[@]}" |
| 50 | +} |
| 51 | + |
| 52 | +function get_imported_classes_in_logger() { |
| 53 | + # File path containing the block of text |
| 54 | + file_path=$(find . -name FeatureFlagsLogger.kt) |
| 55 | + |
| 56 | + # Use sed to extract the block based on a starting pattern and an ending pattern |
| 57 | + extracted_block=$(sed -n '/class FeatureFlagsLogger @Inject constructor(/,/^)/p' "$file_path") |
| 58 | + |
| 59 | + # Get annotation classes |
| 60 | + logged_classes=$(grep -E '@Enable[A-Za-z0-9_]+' "$file_path") |
| 61 | + |
| 62 | + # Replace the @ symbol and spaces within each element of the list |
| 63 | + for i in "${!logged_classes[@]}"; do |
| 64 | + logged_classes[$i]=$(echo "${logged_classes[$i]}" | tr -d '@' | tr -d ' ') |
| 65 | + done |
| 66 | + |
| 67 | + # Print the logged classes |
| 68 | + echo "$logged_classes" |
| 69 | +} |
| 70 | + |
| 71 | +function get_flags_added_into_the_logging_map() { |
| 72 | + # File path containing the block of text |
| 73 | + file_path=$(find . -name FeatureFlagsLogger.kt) |
| 74 | + |
| 75 | + # Use sed to extract the block based on a starting pattern and an ending pattern |
| 76 | + extracted_block=$(sed -n '/Map<String, PlatformParameterValue<Boolean>> = mapOf(/,/)$/p' "$file_path") |
| 77 | + |
| 78 | + # Get any word beginning with enable from the extracted block |
| 79 | + enable_flags=$(grep -E 'enable[A-Za-z0-9_]+' <<<"$extracted_block") |
| 80 | + |
| 81 | + added_flags=() |
| 82 | + |
| 83 | + # Convert the string into an array, splitting by newline |
| 84 | + IFS=$'\n' read -rd '' -a added_flags <<<"$enable_flags" |
| 85 | + |
| 86 | + # Create an empty array to hold individual class names |
| 87 | + class_names=() |
| 88 | + |
| 89 | + # Iterate through each line and take the last word of the list |
| 90 | + for line in "${added_flags[@]}"; do |
| 91 | + # Remove the comma at the end of the line |
| 92 | + line=$(echo "$line" | awk '{sub(/,$/, ""); print}') |
| 93 | + |
| 94 | + # Convert each line into an array of words, splitting by space |
| 95 | + IFS=' ' read -ra words <<<"$line" |
| 96 | + |
| 97 | + # Get last element of the list |
| 98 | + last_element="${words[${#words[@]}-1]}" |
| 99 | + |
| 100 | + # Capitalize last element using sed |
| 101 | + last_element=$(echo "$last_element" | awk '{for(i=1;i<=NF;i++) $i=toupper(substr($i,1,1)) substr($i,2)}1') |
| 102 | + |
| 103 | + # Add the element into class_names |
| 104 | + class_names+=("$last_element") |
| 105 | + done |
| 106 | + |
| 107 | + echo "${class_names[@]}" |
| 108 | +} |
| 109 | + |
| 110 | +function perform_checks_on_feature_flags() { |
| 111 | + feature_flags=($(get_classes_from_constants_file)) |
| 112 | + imported_classes=($(get_imported_classes_in_logger)) |
| 113 | + flags_added_to_map=($(get_flags_added_into_the_logging_map)) |
| 114 | + |
| 115 | + file_path=$(find . -name FeatureFlagsLogger.kt) |
| 116 | + imports_line_number=$(grep -n 'class FeatureFlagsLogger @Inject constructor(' "$file_path" | head -n 1 | awk -F: '{print $1}') |
| 117 | + flags_map_line_number=$(grep -n 'Map<String, PlatformParameterValue<Boolean>> = mapOf(' "$file_path" | head -n 1 | awk -F: '{print $1}') |
| 118 | + |
| 119 | + for element in "${feature_flags[@]}"; do |
| 120 | + in_array=$(item_in_array "$element" "${imported_classes[@]}") |
| 121 | + if [[ $in_array -ne 1 ]]; then |
| 122 | + failed_checks=$((failed_checks + 1)) |
| 123 | + echo "$element is not imported in the constructor argument in $file_path at line $imports_line_number" |
| 124 | + fi |
| 125 | + done |
| 126 | + |
| 127 | + for element in "${feature_flags[@]}"; do |
| 128 | + in_array=$(item_in_array "$element" "${flags_added_to_map[@]}") |
| 129 | + if [[ $in_array -ne 1 ]]; then |
| 130 | + failed_checks=$((failed_checks + 1)) |
| 131 | + echo "$element is not added to the logging map in $file_path at line $flags_map_line_number" |
| 132 | + fi |
| 133 | + done |
| 134 | + |
| 135 | + if [[ $failed_checks -eq 0 ]]; then |
| 136 | + echo "Feature flag checks completed successfully" |
| 137 | + exit 0 |
| 138 | + else |
| 139 | + echo "********************************" |
| 140 | + echo "Feature flag issues found." |
| 141 | + echo "Please fix the above issues." |
| 142 | + echo "********************************" |
| 143 | + exit 1 |
| 144 | + fi |
| 145 | +} |
| 146 | + |
| 147 | +perform_checks_on_feature_flags |
0 commit comments