Teamscale

https://docs.teamscale.com
Admin
Teamscale is a software intelligence platform that helps teams analyze, monitor, and improve the...
Tokens:170,724
Snippets:3,042
Trust Score:8.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install init.d service

Source: https://docs.teamscale.com/howto/installing-as-linux-service

Executes the installation script for the init.d service.

```bash
sudo ./install-service.sh teamscale
```

--------------------------------

### Install Teamscale Java Profiler via Installer

Source: https://docs.teamscale.com/howto/setting-up-profiler-tga/java

Run the installer command to set up the profiler on Linux or Windows systems.

```shell
sudo ./installer install https://your.teamscale.url your-build-user-name your-access-token
```

--------------------------------

### Full .teamscale.toml configuration example

Source: https://docs.teamscale.com/reference/teamscale-toml

A comprehensive example showing all available configuration keys and their default behaviors.

```toml
# The Teamscale IDE configuration file format version of this file.

version = "1.0" # Optional, default: 1.0

# Whether this is the root config file.
# If true, configuration discovery stops at this file and does not continue upwards to the filesystem root.

root = false # Optional, default: false

[server]

# The URL of the Teamscale server.
# If set, it must match the URL of a server for which credentials (Username, Access Key) have been configured in the respective IDE.

url = "https://teamscale.io/" # Optional, but must be set in the merged configuration

[project]

# The Project ID (or one of its Alternative Project IDs) of the Teamscale project.
# Note that the Project ID may be different from the more prominently displayed Project Name.
#
# If a .teamscale.toml file sets the project.id and does not set project.path
# explicitly, then it implicitly sets project.path = "" (i.e., associates the
# current folder with the root folder of the Teamscale project).

id = "example" # Optional, but must be set in the merged configuration

# The branch to use for retrieving data from the server.
# 
# If empty or unset, the applicable branch is discovered from the VCS, with the
# Teamscale default branch being a fallback.
# If set and non-empty, branch auto-discovery is not used. Instead, the given branch is used

branch = "main" # Optional

# The code path within the Teamscale project on the server.
#
# Paths from parent configs will be overwritten.
# Forward-slashes are used as path separators.
# If empty (i.e., path = ""), the Teamscale project root is used as code path.

path = "remote/path" # Optional
```

--------------------------------

### Start init.d service

Source: https://docs.teamscale.com/howto/installing-as-linux-service

Starts the Teamscale service using the service command.

```bash
sudo service teamscale start
```

--------------------------------

### Install Teamscale Service

Source: https://docs.teamscale.com/howto/installing-as-windows-service

Execute the service executable with the install command as an administrator.

```powershell
teamscale-service.exe install
```

--------------------------------

### Collector Configuration File Example

Source: https://docs.teamscale.com/reference/coverage-profilers/teamscale-javascript-profiler

Example content for a configuration file used with the --collector-config-file flag.

```text
teamscaleProject=powersense
teamscalePartition=GenU25-aarch
dumpAfterMins=90
```

--------------------------------

### Example Teamscale Upload Configuration

Source: https://docs.teamscale.com/reference/coverage-profilers/teamscale-dotnet-profiler

A complete configuration example for uploading coverage data directly to Teamscale.

```yaml
match:
  - # Disable profiling globally
    profiler:
      enabled: false

  - executableName: 'myapp.exe'
    profiler:
      enabled: true
      targetdir: 'C:\Users\Public\Traces'
      upload_daemon: true
    uploader:
      pdbDirectory: '@AssemblyDir'
      revisionFile: '@AssemblyDir\revision.txt'
      assemblyPatterns:
        include: ['MyCompany.*']
      teamscale:
        url: 'http://teamscale.example.com'
        username: 'build'
        accessKey: 'your-access-key'
        project: 'my-project'
        partition: 'Manual Tests'
```

--------------------------------

### Install coverage.py

Source: https://docs.teamscale.com/howto/setting-up-profiler-tga/python

Install the coverage package via pip.

```sh
pip install coverage
```

--------------------------------

### Install teamscale-build via Homebrew

Source: https://docs.teamscale.com/reference/cli/teamscale-build

Installs the teamscale-build CLI tool using the previously added Homebrew tap.

```bash
brew install teamscale-build
```

--------------------------------

### Install IstanbulJS Dependencies

Source: https://docs.teamscale.com/howto/setting-up-profiler-tga/nodejs

Install the necessary nyc package for coverage recording.

```bash
npm install --save-dev nyc
```

```bash
npm install --save-dev @istanbuljs/nyc-config-typescript
```

--------------------------------

### Start systemd service

Source: https://docs.teamscale.com/howto/installing-as-linux-service

Manually initiates the Teamscale service process.

```bash
sudo systemctl start teamscale.service
```

--------------------------------

### Create Manual Profiler Configuration

Source: https://docs.teamscale.com/howto/setting-up-profiler-tga/java

Define the connection details in a teamscale.properties file for manual installations.

```properties
url=https://your.teamscale.url
username=your-build-user-name
accesskey=your-access-token
```

--------------------------------

### Create .teamscale-dev.args file

Source: https://docs.teamscale.com/reference/cli/teamscale-dev

Example content for an argument file to store credentials securely.

```text
--server https://username:accesskey@example.com/teamscale/
```

--------------------------------

### Enable systemd service

Source: https://docs.teamscale.com/howto/installing-as-linux-service

Configures the Teamscale service to start automatically upon system boot.

```bash
sudo systemctl enable teamscale.service
```

--------------------------------

### Minimal .teamscale.toml configuration

Source: https://docs.teamscale.com/reference/teamscale-toml

A concise example using TOML's dot-notation for nested keys.

```toml
server.url = "https://teamscale.io/"
project.id = "example"
```

--------------------------------

### Clone the Tutorial Repository

Source: https://docs.teamscale.com/tutorial/tia-java

Initial step to obtain the sample Java project for the tutorial.

```bash
git clone https://github.com/<path-to-your-repo>
```

--------------------------------

### Start Teamscale with nohup

Source: https://docs.teamscale.com/changelog/v8.1.x

Use this command for custom Linux setups that rely on nohup for process management.

```bash
nohup ./teamscale.sh &
```

--------------------------------

### Skip to Tutorial Step

Source: https://docs.teamscale.com/tutorial/tia-java

Commands to reset the repository and prepare the environment for a specific tutorial step.

```sh
git checkout master
git merge origin/step5
./gradlew --continue clean test teamscaleTestUpload
```

```sh
git checkout master
git merge origin/step6
./gradlew --continue clean test teamscaleTestUpload
```

```sh
git checkout master
git merge origin/step7
./gradlew --continue clean test teamscaleTestUpload
```

--------------------------------

### GET /test

Source: https://docs.teamscale.com/reference/coverage-profilers/teamscale-java-profiler/testwise-coverage-recording

Returns the testPath of the current test. The result will be empty when the test already finished or was not started yet.

```APIDOC
## GET /test

### Description
Returns the testPath of the current test. The result will be empty when the test already finished or was not started yet.

### Method
GET

### Endpoint
/test
```

--------------------------------

### Manual VSIX Extension Installation

Source: https://docs.teamscale.com/troubleshooting

Use the command line to install the Teamscale Visual Studio extension when the installer crashes.

```powershell
\path\to\visualstudio\Common7\IDE\VSIXInstaller.exe /q <YOUR-TEAMSCALE_EXTENSION.vsix>
```

--------------------------------

### Compare Tutorial Steps

Source: https://docs.teamscale.com/tutorial/tia-java

Use git diff to inspect changes between specific tutorial branches.

```bash
git diff origin/step1 origin/step2
```

--------------------------------

### Create Java Keystore with keytool

Source: https://docs.teamscale.com/howto/configuring-https

Imports a PKCS 12 file into a new Java keystore file. Ensure the same password is used as the one for the private key.

```bash
keytool -importkeystore -srckeystore myhost.p12 -srcstoretype pkcs12 -destkeystore myhost.jks
```

--------------------------------

### Skip Tutorial Steps

Source: https://docs.teamscale.com/tutorial/tia-java

Reset the local repository to continue from a specific tutorial step.

```sh
git checkout master
git merge origin/step1
```

--------------------------------

### Install teamscale-dev on Linux

Source: https://docs.teamscale.com/getting-started/other-ides

Extract the downloaded archive to /opt and create a symbolic link to the executable in /usr/local/bin.

```bash
sudo unzip teamscale-dev*.zip -d /opt/
sudo ln -s /opt/teamscale-dev/bin/teamscale-dev /usr/local/bin/
```

--------------------------------

### Inspect Step 1 Changes

Source: https://docs.teamscale.com/tutorial/tia-java

View the specific changes applied in the first step of the tutorial.

```sh
git diff origin/master origin/step1
```

--------------------------------

### Install Global nyc for External Environments

Source: https://docs.teamscale.com/howto/setting-up-profiler-tga/nodejs

Install nyc globally when running tests on a separate test environment.

```bash
npm install -g nyc
```

--------------------------------

### Example Artifactory Repository Structure

Source: https://docs.teamscale.com/howto/uploading-external-data

A concrete example of how coverage and findings reports should be organized within an Artifactory repository.

```text
- MyRepository
|
| -> MyProjectName
  |
  | -> uploads
    |
    | -> master
      |
      | -> 1578650400000-4e8afe52737255ba40875a1af1fced1e08fc5316
        |
        | -> coverage
          |
          | -> LCOV
            |
            | -> lcov-reports.zip
        |
        | -> findings
          |
          | -> GENERIC_FINDINGS
            |
            | -> findings-reports.zip
      |
      | -> 1578651300000-70eb476d01abd0d877d064f57a6da5e14c677687
        |
        | -> coverage
          |
          | -> LCOV
            |
            | -> lcov-reports.zip
```

--------------------------------

### Display help for teamscale-dev

Source: https://docs.teamscale.com/reference/cli/teamscale-dev

Lists all available commands and options for the CLI.

```shell
teamscale-dev --help
```

--------------------------------

### Install teamscale-dev via Homebrew on macOS

Source: https://docs.teamscale.com/getting-started/other-ides

Use the Homebrew package manager to tap the Teamscale repository and install the CLI tool.

```bash
brew tap cqse/teamscale https://homebrew.teamscale.com/
brew install teamscale-dev
```

--------------------------------

### Install Teamscale via Eclipse p2 director

Source: https://docs.teamscale.com/getting-started/eclipse

Use the Eclipse p2 director to install the plug-in from a local update site archive.

```bash
eclipse -nosplash -application org.eclipse.equinox.p2.director -repository file:///path/to/teamscale-eclipse-update-site -installIU com.teamscale.ide
```

--------------------------------

### Displaying CLI Help

Source: https://docs.teamscale.com/reference/cli/teamscale-dev

Use the --help flag to list available options for any teamscale-dev command.

```shell
teamscale-dev pre-commit --help
```

--------------------------------

### Testrun Start Request Body Format

Source: https://docs.teamscale.com/reference/coverage-profilers/teamscale-java-profiler/testwise-coverage-recording

The expected JSON structure for providing a list of available test cases when starting a test run.

```json
  [
      {
        "clusterId": "<ID of the cluster the test belongs to>",
        "uniformPath": "<Unique name of the test case>",
        "sourcePath": "<Optional: Path to the source of the test>",
        "content": "<Optional: Value to detect changes to the test, e.g. hash code, revision, ...>"
      }
  ]
```

--------------------------------

### GET /commit

Source: https://docs.teamscale.com/reference/coverage-profilers/teamscale-java-profiler/advanced-setup

Retrieves the current commit.

```APIDOC
## [GET] /commit

### Description
Returns the current commit used for uploading to Teamscale. Before changing the commit, it performs a dump of all coverage collected so far under the previous commit.

### Method
GET

### Endpoint
/commit
```

--------------------------------

### Example Profiler Configuration

Source: https://docs.teamscale.com/howto/setting-up-profiler-tga/java/setup-profiler-configuration

The generated configuration file defining the included packages, target Teamscale project, and partition name.

```properties
includes=*com.company.product.*;*com.example.commons.*
teamscale-project=my-application
teamscale-partition=Manual Tests
```

--------------------------------

### GET /revision

Source: https://docs.teamscale.com/reference/coverage-profilers/teamscale-java-profiler/advanced-setup

Retrieves the current revision.

```APIDOC
## [GET] /revision

### Description
Returns the current revision used for uploading to Teamscale. Before changing the revision, it performs a dump of all coverage collected so far under the previous revision.

### Method
GET

### Endpoint
/revision
```

--------------------------------

### Create a Java Trust Store

Source: https://docs.teamscale.com/howto/connecting-via-https

Use the keytool command to import a DER-formatted certificate into a new Java Keystore file.

```bash
keytool -importcert -file certificate.cer -keystore truststore.jks -alias Alias
```
Tokens:
Raw