# Licensed 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 typing as ty

from keystoneauth1 import loading
from keystoneauth1.loading import opts
from keystoneauth1 import token_endpoint


class AdminToken(loading.BaseLoader[token_endpoint.Token]):
    """Authenticate with an existing token and a known endpoint.

    This plugin is primarily useful for development or for use with identity
    service ADMIN tokens. Because this token is used directly there is no
    fetching a service catalog or determining scope information and so it
    cannot be used by clients that expect use this scope information.

    Because there is no service catalog the endpoint that is supplied with
    initialization is used for all operations performed with this plugin so
    must be the full base URL to an actual service.
    """

    @property
    def plugin_class(self) -> ty.Type[token_endpoint.Token]:
        return token_endpoint.Token

    def get_options(self) -> list[opts.Opt]:
        options = super().get_options()

        options.extend(
            [
                loading.Opt(
                    'endpoint',
                    deprecated=[loading.Opt('url')],
                    help='The endpoint that will always be used',
                ),
                loading.Opt(
                    'token',
                    secret=True,
                    help='The token that will always be used',
                ),
            ]
        )

        return options
