src/ntfc/commands/cmd_collect.py

############################################################################
# SPDX-License-Identifier: Apache-2.0
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.  The
# ASF licenses this file to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance with the
# License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
# License for the specific language governing permissions and limitations
# under the License.
#
############################################################################

"""Module containing NTFC collect command."""

import click

from ntfc.cli.clitypes import cli_testenv_options
from ntfc.cli.environment import Environment, pass_environment

###############################################################################
# Command: cmd_collect
###############################################################################


@click.command(name="collect")
@cli_testenv_options
@click.argument(
    "collect",
    type=str,
    required=False,
    default="all",
)
@pass_environment
def cmd_collect(
    ctx: Environment,
    testpath: str,
    confpath: str,
    collect: str,
    rebuild: bool,
) -> bool:
    """Collect test cases.

    Where COLLECT argument specify what data to print:\n
      collected - collected items,\n
      skipped - skipped items,\n
      modules - test modules,\n
      all - (defualt) print all possible data,\n
      silent - silent\n
    """  # noqa: D301
    ctx.runcollect = True
    ctx.testpath = testpath
    ctx.confpath = confpath
    ctx.collect = collect
    ctx.rebuild = rebuild

    return True