FilesExpand file tree

main

/

check-query-ids.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

44 lines (37 loc) · 1.36 KB

main

/

check-query-ids.py

Copy path

Top

File metadata and controls

• Code
• Blame

44 lines (37 loc) · 1.36 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

from pathlib import Path

import re

import sys

from typing import Dict, List, Optional

ID = re.compile(r" +\* +@id\s*(.*)")

def get_query_id(query_path: Path) -> Optional[str]:

with open(query_path) as f:

for line in f:

m = ID.match(line)

if m:

return m.group(1)

return None

def main():

# Map query IDs to paths of queries with those IDs. We want to check that this is a 1:1 map.

query_ids: Dict[str, List[str]] = {}

# Just check src folders for now to avoid churn

for query_path in Path().glob("**/src/**/*.ql"):

# Skip compiled query packs

if any(p == ".codeql" for p in query_path.parts):

continue

query_id = get_query_id(query_path)

if query_id is not None:

query_ids.setdefault(query_id, []).append(str(query_path))

fail = False

for query_id, query_paths in query_ids.items():

if len(query_paths) > 1:

fail = True

print(f"Query ID {query_id} is used in multiple queries:")

for query_path in query_paths:

print(f" - {query_path}")

if fail:

print("FAIL: duplicate query IDs found in src folders. Please assign these queries unique IDs.")

sys.exit(1)

else:

print("PASS: no duplicate query IDs found in src folders.")

if __name__ == "__main__":

main()