README
¶
COMPILE CHECK
compilecheck sets up the environment so that Java code fragments
generated by gapi-tools can be test-compiled.
Prerequisites
- TODO(vchudnov-g): Fill in.
Testing End to End
* Run the `compilecheck.sh` script. See the comments at the top of that script for information on how to configure it via environment variables.
Documentation
¶
Overview ¶
compilecheck sets up tests to check the validity of generated code samples.
compilecheck does not perform any checking by itself. Instead, it sets up an environment for testing and prints a command the user can run to perform the test.
Usage:
compilecheck [-lib libDir] [-tst tstDir] [-pprof cpu.out] sampleDir...
For each argument in sampleDir, if the argument is a file, compilecheck sets up checks for the file. If it is a directory, compilecheck sets up checks all files in the directory recursively. Symlinks are not followed.
Compilecheck prints to the standard output shell command(s) that maybe run to perform the test.
Options
-lib libDir It maybe necessary to download libraries to test against. If required, libraries are download into subdirectories of libDir. Libraries for different languages are downloaded into subdirectories named after the language, to prevent name collisions. -tst tstDir Files required for testing code samples are written into subdirectories of tstDir. Like -lib, files for different languages are written into different subdirectories. -pprof cpu.out If set, CPU profiling is written to cpu.out.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
csharp
Package csharp implements compile checking for C#.code samples.
|
Package csharp implements compile checking for C#.code samples. |
|
filesys
Package filesys contains abstractions and mocks of the file system, useful for testing.
|
Package filesys contains abstractions and mocks of the file system, useful for testing. |
|
golang
Package golang implements compile checking for Go code samples.
|
Package golang implements compile checking for Go code samples. |
|
java
Package java implements compilecheck for Java.
|
Package java implements compilecheck for Java. |
|
js
Package js implements compilecheck for JS.
|
Package js implements compilecheck for JS. |
|
langutil
Package langutil provides language-independent types useful for processing code snippets and client libraries.
|
Package langutil provides language-independent types useful for processing code snippets and client libraries. |
|
nodejs
Package nodejs implements compilecheck for NodeJS.
|
Package nodejs implements compilecheck for NodeJS. |
|
php
Package php implements compilecheck for PHP.
|
Package php implements compilecheck for PHP. |
|
py
Package py implements compilecheck for Python.
|
Package py implements compilecheck for Python. |
|
ruby
Package ruby implements compilecheck for Ruby.
|
Package ruby implements compilecheck for Ruby. |
Click to show internal directories.
Click to hide internal directories.