codeql. (lsils#537)

.github/workflows/codeql.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+ push:
+ branches: [ master ]
+ pull_request:
+ # The branches below must be a subset of the branches above
+ branches: [ master ]
+ schedule:
+ - cron: '23 11 * * 5'
+
+jobs:
+ analyze:
+ name: Analyze
+ runs-on: ubuntu-latest
+ permissions:
+ actions: read
+ contents: read
+ security-events: write
+
+ strategy:
+ fail-fast: false
+ matrix:
+ language: [ 'cpp' ]
+ # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+ # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v2
+
+ # Initializes the CodeQL tools for scanning.
+ - name: Initialize CodeQL
+ uses: github/codeql-action/init@v1
+ with:
+ languages: ${{ matrix.language }}
+ # If you wish to specify custom queries, you can do so here or in a config file.
+ # By default, queries listed here will override any specified in a config file.
+ # Prefix the list here with "+" to use these queries and those in the config file.
+ # queries: ./path/to/local/query, your-org/your-repo/queries@main
+ queries: hriener/mockturtle/.ql/include.ql@master
+ # queries: security-and-quality
+
+ # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
+ # If this step fails, then you should remove it and run the build manually (see below)
+ - name: Autobuild
+ uses: github/codeql-action/autobuild@v1
+
+ # ℹ️ Command-line programs to run using the OS shell.
+ # 📚 https://git.io/JvXDl
+
+ # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+ # and modify them (or add more) to build your code if your project
+ # uses a compiled language
+
+ # - run: |
+ # g++ test.cpp -o test
+ # ./test
+
+ - name: Perform CodeQL Analysis
+ uses: github/codeql-action/analyze@v1

.ql/include.ql

@@ -0,0 +1,19 @@
+/**
+ * @name Mockturle header included via system path
+ * @description Avoid including mockturtle headers using system include paths.
+ Use the relative local include path instead. For instance, if
+ you want to include `mockturtle/X/Y.hpp` from
+ `mockturtle/A/B.hpp` then use ``#include "../X/Y.hpp"`.
+ * @kind problem
+ * @problem.severity warning
+ * @precision high
+ * @id cpp/mockturtle
+ * @tags mockturtle
+ */
+
+import cpp
+
+from Include i
+where i.getIncludeText().regexpMatch("<mockturtle/[a-z0-9_/]+.hpp>") and
+ i.getFile().toString().matches("%/mockturtle/include/%")
+select i, "Use local include path instead of system include path."

.ql/qlpack.yml

@@ -0,0 +1,4 @@
+name: my-custom-queries
+version: 0.0.0
+dependencies:
+ codeql/cpp-all: "*"

.ql/queries.xml

@@ -0,0 +1 @@
+<queries language="cpp"/>