2cb767d32b
Currently the SATestBuild.py and SATestAdd.py buildbot scripts expect project
sources to be checked into the project repository. This commit changes these
scripts to additionally support a model where project sources are downloaded
rather than checked into the repository. Sometimes projects may need to be
modified (for example, to support a newer versions of clang), so the updated scripts
also allow for an optional patch file that will be applied to the downloaded
project source before analysis.
To support this workflow, this commit changes the expected layout of
a project in the repository. The project-specific helper scripts will stay
in the root of each project directory, but the benchmark source itself (if
checked into the repo) should now be stored in a subdirectory named
'CachedSource':
project_name/
cleanup_run_static_analyzer.sh [optional]
run_static_analyzer.cmd [required]
download_project.sh [optional]
CachedSource/ [optional]
changes_for_analyzer.patch [optional]
If the 'CachedSource' source directory is not present, the download script will
be executed. This script should download the project source into 'CachedSource'.
Then, if 'changes_for_analyzer.patch' is present its changes will
be applied to a copy of 'CachedSource' before analysis.
Differential Revision: http://reviews.llvm.org/D14345
llvm-svn: 252410
107 lines
4.7 KiB
Python
Executable File
107 lines
4.7 KiB
Python
Executable File
#!/usr/bin/env python
|
|
|
|
"""
|
|
Static Analyzer qualification infrastructure: adding a new project to
|
|
the Repository Directory.
|
|
|
|
Add a new project for testing: build it and add to the Project Map file.
|
|
Assumes it's being run from the Repository Directory.
|
|
The project directory should be added inside the Repository Directory and
|
|
have the same name as the project ID
|
|
|
|
The project should use the following files for set up:
|
|
- cleanup_run_static_analyzer.sh - prepare the build environment.
|
|
Ex: make clean can be a part of it.
|
|
- run_static_analyzer.cmd - a list of commands to run through scan-build.
|
|
Each command should be on a separate line.
|
|
Choose from: configure, make, xcodebuild
|
|
- download_project.sh - download the project into the CachedSource/
|
|
directory. For example, download a zip of
|
|
the project source from GitHub, unzip it,
|
|
and rename the unzipped directory to
|
|
'CachedSource'. This script is not called
|
|
when 'CachedSource' is already present,
|
|
so an alternative is to check the
|
|
'CachedSource' directory into the
|
|
repository directly.
|
|
- CachedSource/ - An optional directory containing the source of the
|
|
project being analyzed. If present,
|
|
download_project.sh will not be called.
|
|
- changes_for_analyzer.patch - An optional patch file for any local changes
|
|
(e.g., to adapt to newer version of clang)
|
|
that should be applied to CachedSource
|
|
before analysis. To construct this patch,
|
|
run the the download script to download
|
|
the project to CachedSource, copy the
|
|
CachedSource to another directory (for
|
|
example, PatchedSource) and make any needed
|
|
modifications to the the copied source.
|
|
Then run:
|
|
diff -ur CachedSource PatchedSource \
|
|
> changes_for_analyzer.patch
|
|
"""
|
|
import SATestBuild
|
|
|
|
import os
|
|
import csv
|
|
import sys
|
|
|
|
def isExistingProject(PMapFile, projectID) :
|
|
PMapReader = csv.reader(PMapFile)
|
|
for I in PMapReader:
|
|
if projectID == I[0]:
|
|
return True
|
|
return False
|
|
|
|
# Add a new project for testing: build it and add to the Project Map file.
|
|
# Params:
|
|
# Dir is the directory where the sources are.
|
|
# ID is a short string used to identify a project.
|
|
def addNewProject(ID, BuildMode) :
|
|
CurDir = os.path.abspath(os.curdir)
|
|
Dir = SATestBuild.getProjectDir(ID)
|
|
if not os.path.exists(Dir):
|
|
print "Error: Project directory is missing: %s" % Dir
|
|
sys.exit(-1)
|
|
|
|
# Build the project.
|
|
SATestBuild.testProject(ID, BuildMode, IsReferenceBuild=True, Dir=Dir)
|
|
|
|
# Add the project ID to the project map.
|
|
ProjectMapPath = os.path.join(CurDir, SATestBuild.ProjectMapFile)
|
|
if os.path.exists(ProjectMapPath):
|
|
PMapFile = open(ProjectMapPath, "r+b")
|
|
else:
|
|
print "Warning: Creating the Project Map file!!"
|
|
PMapFile = open(ProjectMapPath, "w+b")
|
|
try:
|
|
if (isExistingProject(PMapFile, ID)) :
|
|
print >> sys.stdout, 'Warning: Project with ID \'', ID, \
|
|
'\' already exists.'
|
|
print >> sys.stdout, "Reference output has been regenerated."
|
|
else:
|
|
PMapWriter = csv.writer(PMapFile)
|
|
PMapWriter.writerow( (ID, int(BuildMode)) );
|
|
print "The project map is updated: ", ProjectMapPath
|
|
finally:
|
|
PMapFile.close()
|
|
|
|
|
|
# TODO: Add an option not to build.
|
|
# TODO: Set the path to the Repository directory.
|
|
if __name__ == '__main__':
|
|
if len(sys.argv) < 2:
|
|
print >> sys.stderr, 'Usage: ', sys.argv[0],\
|
|
'project_ID <mode>' \
|
|
'mode - 0 for single file project; ' \
|
|
'1 for scan_build; ' \
|
|
'2 for single file c++11 project'
|
|
sys.exit(-1)
|
|
|
|
BuildMode = 1
|
|
if (len(sys.argv) >= 3):
|
|
BuildMode = int(sys.argv[2])
|
|
assert((BuildMode == 0) | (BuildMode == 1) | (BuildMode == 2))
|
|
|
|
addNewProject(sys.argv[1], BuildMode)
|