Review replication: Difference between revisions

From Svacer Wiki
m (Ruseer moved page Rcopy to Review replication)
mNo edit summary
Line 1: Line 1:
== Репликация разметки по правилам (экспериментальная функциональность) ==
При использовании разных версий Svace (или иных анализаторов), разных настроек CI/CD и прочих факторах возможны ситуации, когда снимки (snapshots) в рамках одной ветки (branch) могут иметь различные инварианты и разметка автоматически не переносится. Для решения задачи переноса разметки в таких случаях разработана утилита <code>reviewer</code>, которая позволяет применить декларативно описанные правила переноса к существующей разметке. В дальнейшем данная функциональность будет включена в Svacer и доступна в веб интерфейсе.


=== Описание утилиты ===
Утилита <code>reviewer</code> предназначена для Svacer версии 10 и выше.
NAME:
    reviewer - Svacer review help tool
USAGE:
    reviewer [global options] command [command options] [arguments...]
COMMANDS:
    syntax    Prints help information about rule syntax
    replicate  Replicate non-empty review to invariants according to rules
    help, h    Shows a list of commands or help for one command
GLOBAL OPTIONS:
    --debug              Enabled debug output (default: false)
    --log-file value    Define log file for output
    --host value        Defines URL to svacer server. Format: <nowiki>http://host:port</nowiki>
    --login value        User login. When using env variable SVACER_AUTH_CREDS the format is SVACER_AUTH_CREDS=<login>:<password> (default: admin) [$SVACER_AUTH_CREDS]
    --password value    User password (default: admin)
    --ldap_server value  Server for LDAP authentication [$SVACER_LDAP_SERVER]
    --token value        Defines access token for svacer server [$SVACER_AUTH_TOKEN]
    --help, -h          show help
Основная команда, это <code>replicate</code>  - она позволяет применить декларативные правила к разметке, полученной либо с сервера либо из файла, куда ранее она была выгружена командой <code>svacer markup2 export</code>.
NAME:
    reviewer replicate - Replicate non-empty review to invariants according to rules
USAGE:
    reviewer replicate [command options] <file name> - path to output file with applied rules
OPTIONS:
    --project value  Project name or id
    --branch value  Branch name or id (default: master)
    --file value    Load review from file instead of server. File must be in 'json with new line separator' format. File may be gzipped (must have *.gz extension)
    --rule value    Path to file containing replicate rules
    --html          Produce HTML report showing applied changes.Report wil have name <file name>.html (default: false)
    --verbose        Verbose output of rule applications (default: false)
    --process-all    Process all reviews, even with non-default values (default: false)
    --skip-comments  Skip comments while replicating review information (default: false)
    --skip-status    Skip review status and copy only comments while replicating review information (default: false)
    --help, -h      show help

Revision as of 10:49, 4 March 2025

Репликация разметки по правилам (экспериментальная функциональность)

При использовании разных версий Svace (или иных анализаторов), разных настроек CI/CD и прочих факторах возможны ситуации, когда снимки (snapshots) в рамках одной ветки (branch) могут иметь различные инварианты и разметка автоматически не переносится. Для решения задачи переноса разметки в таких случаях разработана утилита reviewer, которая позволяет применить декларативно описанные правила переноса к существующей разметке. В дальнейшем данная функциональность будет включена в Svacer и доступна в веб интерфейсе.

Описание утилиты

Утилита reviewer предназначена для Svacer версии 10 и выше.

NAME:
   reviewer - Svacer review help tool

USAGE:
   reviewer [global options] command [command options] [arguments...]

COMMANDS:
   syntax     Prints help information about rule syntax
   replicate  Replicate non-empty review to invariants according to rules
   help, h    Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --debug              Enabled debug output (default: false)
   --log-file value     Define log file for output
   --host value         Defines URL to svacer server. Format: http://host:port
   --login value        User login. When using env variable SVACER_AUTH_CREDS the format is SVACER_AUTH_CREDS=<login>:<password> (default: admin) [$SVACER_AUTH_CREDS]
   --password value     User password (default: admin)
   --ldap_server value  Server for LDAP authentication [$SVACER_LDAP_SERVER]
   --token value        Defines access token for svacer server [$SVACER_AUTH_TOKEN]
   --help, -h           show help

Основная команда, это replicate - она позволяет применить декларативные правила к разметке, полученной либо с сервера либо из файла, куда ранее она была выгружена командой svacer markup2 export.

NAME:
   reviewer replicate - Replicate non-empty review to invariants according to rules

USAGE:
   reviewer replicate [command options] <file name> - path to output file with applied rules

OPTIONS:
   --project value  Project name or id
   --branch value   Branch name or id (default: master)
   --file value     Load review from file instead of server. File must be in 'json with new line separator' format. File may be gzipped (must have *.gz extension)
   --rule value     Path to file containing replicate rules
   --html           Produce HTML report showing applied changes.Report wil have name <file name>.html (default: false)
   --verbose        Verbose output of rule applications (default: false)
   --process-all    Process all reviews, even with non-default values (default: false)
   --skip-comments  Skip comments while replicating review information (default: false)
   --skip-status    Skip review status and copy only comments while replicating review information (default: false)
   --help, -h       show help