Create a new project with odasa bootstrap

The quickest way to create a new Semmle analysis project is to use the odasa bootstrap command. The bootstrap tool steps you through the process and generates configuration files that you can reuse later. The process described here gives the steps required to analyze a particular JavaScript project. Other projects will require different responses to some of the bootstrap prompts.

The bootstrap tool's on-screen instructions indicate what you should enter at each step. However, the first time you run it, you may find it useful to refer to the following procedure for some additional information.

Open a command console.

Change to the directory where Semmle Core is installed—for example, /opt/odasa.

The tool guides you through the rest of the process. The remainder of the steps provided below give some additional guidance that you may find useful the first time you run the bootstrap tool.

For additional on-screen information, enter ? at any of the prompts.

Project name

Output from the bootstrap command

*** ODASA Bootstrap ***
(c) Semmle ltd.
Welcome to the ODASA bootstrap utility, which is designed to help you get started by generating a basic configuration file for a new project.
You will be prompted for a series of choices, which will determine the configuration that will be generated. Any time you are prompted for input, you can just enter '?' to see a more detailed explanation of the possible inputs.
Please enter the project name: >

Enter: PDF.js

Project language

Output from the bootstrap command

What is the project language?
- Java [j]: The project is implemented using Java.
- C/C++ [c]: The project is implemented using C or C++.
- C# [C]: The project is implemented using C#.
- COBOL [b]: The project is implemented using COBOL.
- Python [p]: The project is implemented using Python.
- JavaScript/Typescript [J]: The project is implemented using JavaScript and/or TypeScript.
[j|c|C|p|J|?] >

The PDF.js project is written in JavaScript.Enter: J

Notes

Make sure to enter a capital J for JavaScript and not a lowercase j for Java.

The languages listed here depend on your Semmle license and the version of the Semmle software you have installed. If you do not see the JavaScript option, check that your Semmle license includes JavaScript.

Project source

Output from the bootstrap command

How should ODASA obtain the project source?
- Subversion [s]: The source is in Subversion.
- git [g]: The source is in git.
- Mercurial [m]: The source is in Mercurial.
- Detached [d]: The build should be done in a detached source directory.
[s|g|m|d|?] >

The PDF.js project uses Git as the version control system for its source code.Enter: g

Providing the bootstrap tool with the URL of the repository makes it possible to automatically download the latest version of the software each time an analysis is triggered.

Branch

Output from the bootstrap command

Git branch or ref: [default: <empty>] >

Press Enter without specifying a branch name.

The bootstrap tool will default to cloning the code from the "master" branch for the project.

Configure TypeScript analysisDecide whether or not you want to include any TypeScript files (.ts or .tsx) in the analysis. At the time of writing, this example project contains no TypeScript files.Enter: n

This causes all of the PDF.js code base to be extracted, rather than just specific directories or files.

Creating a snapshot

You have now supplied all the information needed for the project file that is used each time a snapshot is generated. You can now go ahead and create a snapshot.

Output from the bootstrap command

Do you want to automatically add a snapshot to the project?
- Yes [y]: Add the latest snapshot to the project.
- No [n]: Do not add the latest snapshot to the project.
[y|n|?] >

Enter: y

This tells the bootstrap tool that you want to clone the current PDF.js source files from GitHub and generate files needed to build a Semmle snapshot. This command will be run at the end of the bootstrap process.

Running a set of analyses

Output from the bootstrap command

Do you want to run a set of analyses against the snapshot?
- Yes [y]: Run an analysis suite on the snapshot.
- No [n]: Do not analyze the snapshot at this time.
[y|n|?] >

Enter: y

This tells the bootstrap tool that you want to run a set of queries to analyze the snapshot. This command will be run at the end of the bootstrap process.

Specifying an analysis suite

Output from the bootstrap command

Which analysis suite should be applied? Leave blank for a default set. [default: <empty>] >