Merge pull request #7 from github/template

Flesh out template directory

Author: Sam Lanning

.github/workflows/ci.yml

@@ -22,3 +22,22 @@ jobs:
 
     - name: Build Images & Run Queries
       run: cd courses/cpp/ctf-segv && ../../../scripts/test-course-latest.sh
+  test-courses-template-actual:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v1
+
+    - name: Login to docker
+      run: docker login docker.pkg.github.com -u github-actions -p ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Build Images & Run Queries
+      run: cd courses/template && ../../scripts/test-course-actual.sh
+  test-courses-template-latest:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v1
+
+    - name: Build Images & Run Queries
+      run: cd courses/template && ../../scripts/test-course-latest.sh

README.md

@@ -21,6 +21,8 @@ including links to the lines of source code on GitHub when possible:
 
 ![](docs/comment_screenshot.png)
 
+<!-- TODO: add README table of contents -->
+
 ## Creating your own course
 
 There are two main components to any Learning Lab course for CodeQL that uses
@@ -110,6 +112,7 @@ we recommend structuring your course folder like so:
 
 ```
 ├── answers               <─── Model Answers
+│   ├── qlpack.yml
 │   ├── step-01.ql        <─┬─ Answers with expected paths
 │   ├── step-02.ql        <─┤  (relative to answers/)
 │   └── ...               <─┘  as specified in config.json

courses/cpp/ctf-segv/image/publish.sh

@@ -1,5 +1,7 @@
 #! /bin/bash
 
+# TODO: move to /scripts/
+
 set -e
 set -x
 

courses/template/action.yml

@@ -0,0 +1,9 @@
+name: 'Check queries'
+description: 'Check that the queries that have been pushed produce the correct results'
+author: 'GitHub <opensource+codeql-learninglab-actions@github.com>'
+runs:
+  using: 'docker'
+  image: 'docker.pkg.github.com/<owner>/<repo>/<pkg>'
+branding:
+  icon: 'check-circle'
+  color: 'purple'

courses/template/answers/qlpack.yml

@@ -0,0 +1,3 @@
+name: course-template
+version: 0.0.0
+libraryPathDependencies: codeql-cpp # Update this with appropriate language

courses/template/answers/step-01.ql

@@ -0,0 +1,5 @@
+import cpp
+
+from Function f
+where f.getName() = "getchar"
+select f

courses/template/answers/step-02.ql

@@ -0,0 +1,5 @@
+import cpp
+
+from Function f
+where f.getName() = "getchar"
+select f

courses/template/image/Dockerfile

@@ -0,0 +1,7 @@
+FROM docker.pkg.github.com/github/codeql-learninglab-actions/codeql-learninglab-check:v0.0.6
+
+## Add course config
+COPY --chown=codeql:codeql config /home/codeql/config
+WORKDIR /home/codeql/config
+# Download, unzip and then delete the zip file in one step to reduce image size
+RUN wget --quiet https://downloads.lgtm.com/snapshots/cpp/GNU/glibc/bminor_glibc_cpp-srcVersion_333221862ecbebde60dd16e7ca17d26444e62f50-dist_odasa-lgtm-2019-04-08-af06f68-linux64.zip -O snapshot.zip && unzip -qq snapshot.zip && rm -rf snapshot.zip

courses/template/image/config/config.json

@@ -0,0 +1,8 @@
+{
+  "snapshotPath": "bminor_glibc_3332218",
+  "locationPaths": "https://github.com/<org>/<repo>/blob/<sha>{path}#L{line-start}-L{line-end}",
+  "expectedResults": {
+    "step-01.ql": "step-01.csv",
+    "step-02.ql": "step-02.csv"
+  }
+}

courses/template/image/config/step-01.csv

@@ -0,0 +1,4 @@
+"f","URL for f","col1"
+"getchar","file:///opt/src/libio/getchar.c:33:1:33:7","a getchar function"
+"getchar","file:///opt/src/libio/bits/stdio.h:47:1:47:7","a getchar function"
+"getchar","file:///opt/src/libio/bits/stdio.h:47:1:47:7","a getchar function"