commonMain.aws.sdk.kotlin.runtime.config.profile.ParseFn.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-config-jvm Show documentation
Support for AWS configuration
There is a newer version: 1.3.76
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
package aws.sdk.kotlin.runtime.config.profile

/**
 * Describes a function that attempts to parse a line into a [Token] or returns null on failure.
 *
 * The implemented parse functions will fail to tokenize otherwise-valid lines depending on the passed parser state. For
 * example, a valid property definition line will not be recognized if a valid profile line has not been encountered
 * first.
 */
internal typealias ParseFn = (input: FileLine, currentSection: Token.Section?, lastProperty: Token.Property?) -> Token?

/**
 * Format (Configuration Files): [ Whitespace? [profile|sso-session] Whitespace Identifier Whitespace? ] Whitespace? CommentLine?
 */
internal fun configurationSection(input: FileLine, currentSection: Token.Section?, lastProperty: Token.Property?): Token.Section? {
    if (!input.isSection()) return null

    val parts = input.content
        .stripInlineComments()
        .stripComments()
        .drop(1)
        .dropLast(1)
        .splitWhitespace(limit = 2)

    val hasSectionPrefix = parts.firstOrNull() != Literals.DEFAULT_PROFILE

    val sectionType = when (parts[0]) {
        Literals.SSO_SESSION_KEYWORD -> ConfigSectionType.SSO_SESSION
        Literals.SERVICES_KEYWORD -> ConfigSectionType.SERVICES
        Literals.PROFILE_KEYWORD, Literals.DEFAULT_PROFILE -> ConfigSectionType.PROFILE
        else -> ConfigSectionType.UNKNOWN
    }

    // sso-session name is required, only default profile can omit name
    val name = parts.lastOrNull() ?: ""

    val isValid = (parts.size == 1 && parts[0] == Literals.DEFAULT_PROFILE) ||
        (parts.size == 2 && name.isNotEmpty() && hasSectionPrefix && parts[1].isValidIdentifier())

    return Token.Section(name, sectionType, hasSectionPrefix, isValid)
}

/**
 * Format (Credentials Files): [ Whitespace? Identifier Whitespace? ] Whitespace? CommentLine?
 */
internal fun credentialProfile(input: FileLine, currentSection: Token.Section?, lastProperty: Token.Property?): Token.Section? {
    if (!input.isProfile()) return null

    val name = input.content
        .stripInlineComments()
        .stripComments()
        .drop(1)
        .dropLast(1)
        .trim()

    return Token.Section(name, ConfigSectionType.PROFILE, false, name.isValidIdentifier())
}

/**
 * Format: Identifier Whitespace? = Whitespace? Value? Whitespace? (Whitespace CommentLine)?
 *
 * Defines a top-level property as part of a profile. Property values MAY be empty.
 */
internal fun property(input: FileLine, currentSection: Token.Section?, lastProperty: Token.Property?): Token.Property? {
    if (!input.isProperty()) return null
    if (currentSection == null) return null

    val (key, value) = input.content.splitProperty()
    return Token.Property(key, value.stripInlineComments())
}

/**
 * Format: Whitespace Value Whitespace?
 *
 * Appends to a previously-defined (non-empty) property.
 */
internal fun continuation(input: FileLine, currentSection: Token.Section?, lastProperty: Token.Property?): Token.Continuation? {
    if (!input.isContinuation()) return null
    if (lastProperty == null || lastProperty.value.isEmpty()) return null

    return Token.Continuation(input.content.trim()) // inline comments are NOT stripped
}

/**
 * Format: Whitespace Identifier Whitespace? = Whitespace? Value Whitespace?
 *
 * A [continuation] that satisfies the following extra conditions:
 * - matches the syntax of a property definition (excluding the leading whitespace)
 * - follows a property definition with an empty value
 *
 * Parsed like a normal property definition, except any attempt at an inline comment is treated as part of the value.
 */
internal fun subProperty(input: FileLine, currentSection: Token.Section?, lastProperty: Token.Property?): Token.SubProperty? {
    if (!input.isSubProperty()) return null
    if (lastProperty == null || lastProperty.value.isNotEmpty()) return null

    val (key, value) = input.content.splitProperty()
    return Token.SubProperty(key, value) // inline comments are NOT stripped
}