chore: Add CI to block on TODOs (#713)

* chore: Add CI to block on TODOs

Author: lavaleri

Diff for: .github/workflows/ci_examples_java.yml

@@ -32,9 +32,6 @@ jobs:
       matrix:
         java-version: [ 8, 11, 16, 17 ]
         os: [
-          # TODO just test on mac for now
-          #windows-latest,
-          #ubuntu-latest,
           macos-latest
         ]
     runs-on: ${{ matrix.os }}

Diff for: .github/workflows/ci_examples_net.yml

@@ -18,8 +18,6 @@ jobs:
         ]
         dotnet-version: [ '6.0.x' ]
         os: [
-          # TODO windows-latest,
-          # ubuntu-latest,
           macos-latest,
         ]
     runs-on: ${{ matrix.os }}

Diff for: .github/workflows/ci_test_java.yml

@@ -34,9 +34,6 @@ jobs:
         ]
         java-version: [ 8, 11, 16, 17 ]
         os: [
-          # TODO just test on mac for now
-          #windows-latest,
-          #ubuntu-latest,
           macos-latest
         ]
     runs-on: ${{ matrix.os }}

Diff for: .github/workflows/ci_test_net.yml

@@ -35,8 +35,6 @@ jobs:
         ]
         dotnet-version: [ '6.0.x' ]
         os: [
-          # TODO windows-latest,
-          # ubuntu-latest,
           macos-latest,
         ]
     runs-on: ${{ matrix.os }}

Diff for: .github/workflows/ci_todos.yml

@@ -0,0 +1,24 @@
+# This workflow prevents TODOs in code
+name: Check TODOs in code
+
+on: 
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  findTodos:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Check TODOs in code
+        shell: bash
+        # TODOs may be committed as long as the same line contains a link to a Github Issue or refers to a CrypTool SIM.
+        run: |
+          ALL_TODO_COUNT=$( { grep -r "TODO" . --exclude-dir=./submodules --exclude-dir=./.git --exclude=./.github/workflows/ci_todos.yml || true; } | wc -l)
+          GOOD_TODO_COUNT=$( { grep -r "TODO.*\(github.com\/.*issues.*\/[1-9][0-9]*\|CrypTool-[1-9][0-9]*\)" . --exclude-dir=./submodules --exclude-dir=./.git  --exclude=./.github/workflows/ci_todos.yml || true; } | wc -l)
+          if [ "$ALL_TODO_COUNT" != "$GOOD_TODO_COUNT" ]; then
+            exit 1;
+          fi

Diff for: TestVectors/dafny/DDBEncryption/src/TestVectors.dfy

@@ -1,16 +1,6 @@
 // Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-/*
-  TODO
-    queries that should pass in vanilla and fail in gazelle
-    configs that should fail
-    Better information printed on failure
-    Both algo suites, ensure fail if different on decrypt
-    Multiple Tables in config
-    Use vanilla client to damage encrypted record in subtle ways, ensure failure
-*/
-
 include "../Model/AwsCryptographyDynamoDbEncryptionTypesWrapped.dfy"
 include "CreateInterceptedDDBClient.dfy"
 include "JsonItem.dfy"
@@ -590,7 +580,6 @@ module {:options "-functionSyntax:4"} DdbEncryptionTestVectors {
     }
     predicate QueryOutputEqual(actual : DDB.ItemList, expected : DDB.ItemList)
     {
-      // TODO - maybe the order isn't guaranteed?
       actual == expected
     }
 
@@ -876,7 +865,7 @@ module {:options "-functionSyntax:4"} DdbEncryptionTestVectors {
             ReturnConsumedCapacity := None
           )
         );
-        expect result.UnprocessedKeys.None? || |result.UnprocessedKeys.value| == 0; // TODO - actually handle this
+        expect result.UnprocessedKeys.None? || |result.UnprocessedKeys.value| == 0;
         expect result.Responses.Some?;
         expect |result.Responses.value| == 1;
         expect TableName in result.Responses.value;