/* Copyright (c) 2002-2018 Pigeonhole authors, see the included COPYING file

 */

#include "sieve-common.h"

#include "sieve-script.h"

#include "sieve-commands.h"

#include "sieve-validator.h"

#include "sieve-generator.h"

#include "sieve-interpreter.h"

#include "sieve-code.h"

#include "sieve-binary.h"

#include "sieve-dump.h"

#include "sieve.h"

#include "testsuite-common.h"

#include "testsuite-script.h"

#include "testsuite-result.h"

/*

 * Test_script_run command

 *

 * Syntax:

 *   test_script_run

 */

static bool tst_test_script_run_registered

(struct sieve_validator *validator, const struct sieve_extension *ext,

  struct sieve_command_registration *cmd_reg);

static bool tst_test_script_run_generate

  (const struct sieve_codegen_env *cgenv, struct sieve_command *cmd);

const struct sieve_command_def tst_test_script_run = {

  .identifier = "test_script_run",

  .type = SCT_TEST,

  .positional_args = 0,

  .subtests = 0,

  .block_allowed = FALSE,

  .block_required = FALSE,

  .registered = tst_test_script_run_registered,

  .generate = tst_test_script_run_generate

};

/*

 * Operation

 */

static bool tst_test_script_run_operation_dump

  (const struct sieve_dumptime_env *denv, sieve_size_t *address);

static int tst_test_script_run_operation_execute

  (const struct sieve_runtime_env *renv, sieve_size_t *address);

const struct sieve_operation_def test_script_run_operation = {

  .mnemonic = "TEST_SCRIPT_RUN",

  .ext_def = &testsuite_extension,

  .code = TESTSUITE_OPERATION_TEST_SCRIPT_RUN,

  .dump = tst_test_script_run_operation_dump,

  .execute = tst_test_script_run_operation_execute

};

/*

 * Tagged arguments

 */

/* Codes for optional arguments */

enum cmd_vacation_optional {

  OPT_END,

  OPT_APPEND_RESULT

};

/* Tags */

static const struct sieve_argument_def append_result_tag = {

  .identifier = "append_result"

};

static bool tst_test_script_run_registered

(struct sieve_validator *validator, const struct sieve_extension *ext,

  struct sieve_command_registration *cmd_reg)

{

  sieve_validator_register_tag

    (validator, cmd_reg, ext, &append_result_tag, OPT_APPEND_RESULT);

  return TRUE;

}

/*

 * Code generation

 */

static bool tst_test_script_run_generate

(const struct sieve_codegen_env *cgenv, struct sieve_command *tst)

{

  sieve_operation_emit(cgenv->sblock, tst->ext, &test_script_run_operation);

  return sieve_generate_arguments(cgenv, tst, NULL);

}

/*

 * Code dump

 */

static bool tst_test_script_run_operation_dump

(const struct sieve_dumptime_env *denv, sieve_size_t *address)

{

  int opt_code = 0;

  sieve_code_dumpf(denv, "TEST_SCRIPT_RUN");

  sieve_code_descend(denv);

  /* Dump optional operands */

  for (;;) {

    int opt;

    if ( (opt=sieve_opr_optional_dump(denv, address, &opt_code)) < 0 )

      return FALSE;

    if ( opt == 0 ) break;

    switch ( opt_code ) {

    case OPT_APPEND_RESULT:

      sieve_code_dumpf(denv, "append_result");

      break;

    default:

      return FALSE;

    }

  }

  return TRUE;

}

/*

 * Intepretation

 */

static int tst_test_script_run_operation_execute

(const struct sieve_runtime_env *renv, sieve_size_t *address)

{

  bool append_result = FALSE;

  int opt_code = 0;

  bool result = TRUE;

  /*

   * Read operands

   */

  /* Optional operands */

  for (;;) {

    int opt;

    if ( (opt=sieve_opr_optional_read(renv, address, &opt_code)) < 0 )

      return SIEVE_EXEC_BIN_CORRUPT;

    if ( opt == 0 ) break;

    switch ( opt_code ) {

    case OPT_APPEND_RESULT:

      append_result = TRUE;

      break;

    default:

      sieve_runtime_trace_error(renv,

        "unknown optional operand");

      return SIEVE_EXEC_BIN_CORRUPT;

    }

  }

  /*

   * Perform operation

   */

  sieve_runtime_trace(renv, SIEVE_TRLVL_TESTS,

    "testsuite: run compiled script [append_result=%s]",

    ( append_result ? "yes" : "no" ));

  /* Reset result object */

  if ( !append_result )

    testsuite_result_reset(renv);

  /* Run script */

  result = testsuite_script_run(renv);

  if ( sieve_runtime_trace_active(renv, SIEVE_TRLVL_TESTS) ) {

    sieve_runtime_trace_descend(renv);

    sieve_runtime_trace(renv, 0, "execution of script %s",

      ( result ? "succeeded" : "failed" ));

  }

  /* Indicate test status */

  sieve_interpreter_set_test_result(renv->interp, result);

  return SIEVE_EXEC_OK;

}