tools/pytools/lib/execute/pulsar_perf_clidoc_generator.py

# 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.

import os
from pathlib import Path

from command import run
from constant import site_path


def execute(basedir: Path, version: str):
    perf = basedir / 'bin' / 'pulsar-perf'
    reference = site_path() / 'static' / 'reference' / version / 'pulsar-perf'

    reference.mkdir(exist_ok=True, parents=True)
    with (reference / 'pulsar-perf.md').open('w') as f:
        run(str(perf.absolute()), 'gen-doc', stdout=f, env={
                **os.environ,
            })