mirror of https://github.com/google/oss-fuzz.git
86 lines
2.9 KiB
Python
86 lines
2.9 KiB
Python
# Copyright 2021 Google LLC
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
"""Module for representing the workspace directory which CIFuzz uses."""
|
|
|
|
import os
|
|
import shutil
|
|
|
|
|
|
class Workspace:
|
|
"""Class representing the workspace directory."""
|
|
|
|
def __init__(self, config):
|
|
self.workspace = config.workspace
|
|
|
|
def initialize_dir(self, directory): # pylint: disable=no-self-use
|
|
"""Creates directory if it doesn't already exist, otherwise does nothing."""
|
|
os.makedirs(directory, exist_ok=True)
|
|
|
|
@property
|
|
def repo_storage(self):
|
|
"""The parent directory for repo storage."""
|
|
return os.path.join(self.workspace, 'storage')
|
|
|
|
@property
|
|
def out(self):
|
|
"""The out directory used for storing the fuzzer build built by
|
|
build_fuzzers."""
|
|
# Don't use 'out' because it needs to be used by artifacts.
|
|
return os.path.join(self.workspace, 'build-out')
|
|
|
|
@property
|
|
def work(self):
|
|
"""The directory used as the work directory for the fuzzer build/run."""
|
|
return os.path.join(self.workspace, 'work')
|
|
|
|
@property
|
|
def artifacts(self):
|
|
"""The directory used to store artifacts for download by CI-system users."""
|
|
# This is hardcoded by a lot of clients, so we need to use this.
|
|
return os.path.join(self.workspace, 'out', 'artifacts')
|
|
|
|
@property
|
|
def clusterfuzz_build(self):
|
|
"""The directory where builds from ClusterFuzz are stored."""
|
|
return os.path.join(self.workspace, 'cifuzz-prev-build')
|
|
|
|
@property
|
|
def clusterfuzz_coverage(self):
|
|
"""The directory where builds from ClusterFuzz are stored."""
|
|
return os.path.join(self.workspace, 'cifuzz-prev-coverage')
|
|
|
|
@property
|
|
def coverage_report(self):
|
|
"""The directory where coverage reports generated by cifuzz are put."""
|
|
return os.path.join(self.workspace, 'cifuzz-coverage')
|
|
|
|
@property
|
|
def corpora(self):
|
|
"""The directory where corpora from ClusterFuzz are stored."""
|
|
return os.path.join(self.workspace, 'cifuzz-corpus')
|
|
|
|
@property
|
|
def pruned_corpora(self):
|
|
"""The directory where pruned corpora are stored."""
|
|
return os.path.join(self.workspace, 'cifuzz-pruned-corpus')
|
|
|
|
@property
|
|
def sarif(self):
|
|
"""The directory where sarif files are stored."""
|
|
return os.path.join(self.workspace, 'cifuzz-sarif')
|
|
|
|
def make_repo_for_sarif(self, repo_manager):
|
|
"""Copies the repo over for the sarif upload GitHub action."""
|
|
return shutil.copytree(repo_manager.repo_dir, self.sarif, symlinks=True)
|