Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Bug Report: diagtool not found on Windows

Open Beginner friendly
  • Is something wrong?
#4,802 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
70/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
python
Domain
tooling

Research direction

The lookup is get_diagtool_bin() in analyzer/codechecker_analyzer/analyzers/clangtidy/analyzer.py, which builds diagtool from the clang-tidy binary's parent directory around line 153. Read that function first, then check how sys.platform is handled elsewhere in the codebase. Done means that on win32 it finds diagtool.exe and the versioned diagtool-N.exe variant, while Unix lookup is unchanged.

Written by the indexing model from the issue text.

Description

good to go :rocket:

Bug Report: diagtool not found on Windows

Summary

On Windows systems, CodeChecker fails to find the diagtool binary because it searches for diagtool instead of diagtool.exe.

CodeChecker version

  • Current repository state (commit: ce5ed250)

To Reproduce

Steps to reproduce the behaviour:

  1. Install CodeChecker on Windows
  2. Run analysis with ClangTidy analyzer
  3. The get_diagtool_bin() function in analyzer.py fails to locate diagtool.exe

Root Cause

In analyzer/codechecker_analyzer/analyzers/clangtidy/analyzer.py, line 153:

diagtool_bin = clang_tidy_bin.parent / 'diagtool'

The code hardcodes the binary name as diagtool without considering the .exe extension required on Windows platforms.

Expected Behaviour

The function should:

  • Look for diagtool.exe on Windows (sys.platform == 'win32')
  • Look for diagtool on Unix-like systems
  • Similarly handle versioned binaries like diagtool-14.exe

Affected File

analyzer/codechecker_analyzer/analyzers/clangtidy/analyzer.py - get_diagtool_bin() function

Fix

The fix adds platform-specific binary name handling:

# Find diagtool next to the clang binary.
diagtool_name = 'diagtool.exe' if sys.platform == 'win32' else 'diagtool'
diagtool_bin = clang_tidy_bin.parent / diagtool_name
if diagtool_bin.exists():
    return diagtool_bin

# Sometimes diagtool binary has a version number in its name: diagtool-14.
version = ClangTidy.get_binary_version()

if version:
    versioned_name = f'diagtool-{version.major}'
    if sys.platform == 'win32':
        versioned_name += '.exe'
    if diagtool_bin.with_name(versioned_name).exists():
        return diagtool_bin.with_name(versioned_name)

Desktop (please complete the following information)

  • OS: Windows 11 Pro
  • Platform: win32

Additional Context

  • This issue affects all Windows users using ClangTidy analyzer
  • The same pattern should be checked for any other binary lookups in the codebase
  • The sys.platform == 'win32' check is already used in other parts of the codebase for Windows-specific handling
Dominant language
Python
Stars
2.6k
Forks
494
Avg merge
3d 1h
Merged PRs (30d)
20

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Ericsson/codechecker

All issues in Ericsson/codechecker

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.