Upgrading dependencies and code changes to adapt to updates

Author: JohnPreston

.pre-commit-config.yaml

@@ -1,11 +1,28 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+    rev: v4.2.0
     hooks:
       - id: end-of-file-fixer
       - id: trailing-whitespace
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-yaml
+      - id: check-toml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+      - id: detect-aws-credentials
+      - id: detect-private-key
+      - id: fix-byte-order-marker
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.32.1
+    hooks:
+      - id: pyupgrade
+        args: [ "--py38-plus" ]
+
   - repo: https://github.com/psf/black
-    rev: 21.12b0
+    rev: 22.3.0
     hooks:
       - id: black
   - repo: https://github.com/pycqa/isort

Makefile

@@ -1,4 +1,4 @@
-.PHONY: clean clean-test clean-pyc clean-build docs help
+.PHONY: clean clean-test clean-pyc clean-build docs help data-model
 .DEFAULT_GOAL := help
 
 define BROWSER_PYSCRIPT
@@ -94,15 +94,12 @@ dist: clean ## builds source and wheel package
 	ls -l dist
 
 install: clean ## install the package to the active Python's site-packages
-	pip install . --use-pep517 --use-feature=in-tree-build
+	pip install . --use-pep517
 
 conform	: ## Conform to a standard of coding syntax
 	isort --profile black ecs_files_composer
 	black ecs_files_composer tests
 	find ecs_files_composer -name "*.json" -type f  -exec sed -i '1s/^\xEF\xBB\xBF//' {} +
 
 data-model:
-	datamodel-codegen  --input ecs-files-input.json \
-		--input-file-type jsonschema \
-		--output ecs_files_composer/input.py
-# 		--enum-field-as-literal all
+			datamodel-codegen

ecs-files-input.json

@@ -21,7 +21,6 @@
       "additionalProperties": false,
       "properties": {
         "x509": {
-          "uniqueItems": true,
           "patternProperties": {
             "^/[\\x00-\\x7F]+$": {
               "$ref": "#/definitions/X509CertDef"

ecs_files_composer/certificates_mgmt.py

@@ -1,4 +1,3 @@
-#  -*- coding: utf-8 -*-
 # SPDX-License-Identifier: MPL-2.0
 # Copyright 2020-2021 John Mille<[email protected]>
 
@@ -13,7 +12,7 @@
 from ecs_files_composer.input import X509CertDef
 
 
-class X509Certificate(X509CertDef, object):
+class X509Certificate(X509CertDef):
     """
     Class to wrap actions around a new X509 certificate
     """
@@ -107,8 +106,8 @@ def process_x509_certs(job):
         return
     for cert_path, cert_def in job.certificates.x509.items():
         cert_obj = X509Certificate(
-            keyFileName=cert_def["keyFileName"], certFileName=cert_def["certFileName"]
-        ).parse_obj(cert_def)
+            **(cert_def.dict(by_alias=True)),
+        )
         cert_obj.dir_path = cert_path
         cert_obj.init_cert_paths()
         cert_obj.set_cert_files()

ecs_files_composer/input.py

@@ -1,22 +1,15 @@
 # generated by datamodel-codegen:
 #   filename:  ecs-files-input.json
-#   timestamp: 2021-08-16T12:01:22+00:00
+#   timestamp: 2022-05-18T06:23:25+00:00
 
 from __future__ import annotations
 
 from enum import Enum
-from typing import Any, Dict, List, Optional
+from typing import Dict, List, Optional
 
 from pydantic import AnyUrl, BaseModel, EmailStr, Extra, Field, constr
 
 
-class Certificates(BaseModel):
-    class Config:
-        extra = Extra.forbid
-
-    x509: Optional[Any] = None
-
-
 class Encoding(Enum):
     base64 = "base64"
     plain = "plain"
@@ -28,140 +21,145 @@ class Context(Enum):
 
 
 class UrlDef(BaseModel):
-    url: Optional[AnyUrl] = Field(None, alias="Url")
-    username: Optional[str] = Field(None, alias="Username")
-    password: Optional[str] = Field(None, alias="Password")
+    url: AnyUrl | None = Field(None, alias="Url")
+    username: str | None = Field(None, alias="Username")
+    password: str | None = Field(None, alias="Password")
 
 
 class IamOverrideDef(BaseModel):
-    role_arn: Optional[str] = Field(None, alias="RoleArn")
-    session_name: Optional[str] = Field(
+    role_arn: str | None = Field(None, alias="RoleArn")
+    session_name: str | None = Field(
         "S3File@EcsConfigComposer",
         alias="SessionName",
         description="Name of the IAM session",
     )
-    external_id: Optional[str] = Field(
+    external_id: str | None = Field(
         None,
         alias="ExternalId",
         description="The External ID to use when using sts:AssumeRole",
     )
-    region_name: Optional[str] = Field(None, alias="RegionName")
-    access_key_id: Optional[str] = Field(
+    region_name: str | None = Field(None, alias="RegionName")
+    access_key_id: str | None = Field(
         None, alias="AccessKeyId", description="AWS Access Key Id to use for session"
     )
-    secret_access_key: Optional[str] = Field(
+    secret_access_key: str | None = Field(
         None, alias="SecretAccessKey", description="AWS Secret Key to use for session"
     )
-    session_token: Optional[str] = Field(None, alias="SessionToken")
+    session_token: str | None = Field(None, alias="SessionToken")
 
 
 class CommandsDef(BaseModel):
-    __root__: List[str] = Field(..., description="List of commands to run")
+    __root__: list[str] = Field(..., description="List of commands to run")
 
 
 class X509CertDef(BaseModel):
     class Config:
         extra = Extra.allow
 
-    dir_path: Optional[str] = None
-    email_address: Optional[EmailStr] = Field(
+    dir_path: str | None = None
+    email_address: EmailStr | None = Field(
         "[email protected]", alias="emailAddress"
     )
-    common_name: Optional[
+    common_name: None | (
         constr(
             regex=r"^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]{0,61}[A-Za-z0-9])\Z"
         )
-    ] = Field(None, alias="commonName")
-    country_name: Optional[str] = Field("AW", alias="countryName", regex="^[A-Z]+$")
-    locality_name: Optional[str] = Field("AWS", alias="localityName")
-    state_or_province_name: Optional[str] = Field("AWS", alias="stateOrProvinceName")
-    organization_name: Optional[str] = Field("AWS", alias="organizationName")
-    organization_unit_name: Optional[str] = Field("AWS", alias="organizationUnitName")
-    validity_end_in_seconds: Optional[float] = Field(
+    ) = Field(None, alias="commonName")
+    country_name: str | None = Field("AW", alias="countryName", regex="^[A-Z]+$")
+    locality_name: str | None = Field("AWS", alias="localityName")
+    state_or_province_name: str | None = Field("AWS", alias="stateOrProvinceName")
+    organization_name: str | None = Field("AWS", alias="organizationName")
+    organization_unit_name: str | None = Field("AWS", alias="organizationUnitName")
+    validity_end_in_seconds: float | None = Field(
         8035200,
         alias="validityEndInSeconds",
         description="Validity before cert expires, in seconds. Default 3*31*24*60*60=3Months",
     )
     key_file_name: str = Field(..., alias="keyFileName")
     cert_file_name: str = Field(..., alias="certFileName")
-    group: Optional[str] = Field(
+    group: str | None = Field(
         "root",
         description="UNIX group name or GID owner of the file. Default to root(0)",
     )
-    owner: Optional[str] = Field(
+    owner: str | None = Field(
         "root", description="UNIX user or UID owner of the file. Default to root(0)"
     )
 
 
-class Model(BaseModel):
-    files: Dict[str, Any]
-    certificates: Optional[Certificates] = None
-    iam_override: Optional[IamOverrideDef] = Field(None, alias="IamOverride")
+class Certificates(BaseModel):
+    class Config:
+        extra = Extra.forbid
+
+    x509: dict[str, X509CertDef] | None = None
 
 
 class Commands(BaseModel):
-    post: Optional[CommandsDef] = Field(
+    post: CommandsDef | None = Field(
         None, description="Commands to run after the file was retrieved"
     )
-    pre: Optional[CommandsDef] = Field(
+    pre: CommandsDef | None = Field(
         None,
         description="Commands executed prior to the file being fetched, after `depends_on` completed",
     )
 
 
 class SsmDef(BaseModel):
-    parameter_name: Optional[str] = Field(None, alias="ParameterName")
-    iam_override: Optional[IamOverrideDef] = Field(None, alias="IamOverride")
+    parameter_name: str | None = Field(None, alias="ParameterName")
+    iam_override: IamOverrideDef | None = Field(None, alias="IamOverride")
 
 
 class SecretDef(BaseModel):
     secret_id: str = Field(..., alias="SecretId")
-    version_id: Optional[str] = Field(None, alias="VersionId")
-    version_stage: Optional[str] = Field(None, alias="VersionStage")
-    iam_override: Optional[IamOverrideDef] = Field(None, alias="IamOverride")
+    version_id: str | None = Field(None, alias="VersionId")
+    version_stage: str | None = Field(None, alias="VersionStage")
+    iam_override: IamOverrideDef | None = Field(None, alias="IamOverride")
 
 
 class S3Def(BaseModel):
     bucket_name: str = Field(
         ..., alias="BucketName", description="Name of the S3 Bucket"
     )
-    bucket_region: Optional[str] = Field(
+    bucket_region: str | None = Field(
         None,
         alias="BucketRegion",
         description="S3 Region to use. Default will ignore or retrieve via s3:GetBucketLocation",
     )
     key: str = Field(..., alias="Key", description="Full path to the file to retrieve")
-    iam_override: Optional[IamOverrideDef] = Field(None, alias="IamOverride")
+    iam_override: IamOverrideDef | None = Field(None, alias="IamOverride")
 
 
 class SourceDef(BaseModel):
-    url: Optional[UrlDef] = Field(None, alias="Url")
-    ssm: Optional[SsmDef] = Field(None, alias="Ssm")
-    s3: Optional[S3Def] = Field(None, alias="S3")
-    secret: Optional[SecretDef] = Field(None, alias="Secret")
+    url: UrlDef | None = Field(None, alias="Url")
+    ssm: SsmDef | None = Field(None, alias="Ssm")
+    s3: S3Def | None = Field(None, alias="S3")
+    secret: SecretDef | None = Field(None, alias="Secret")
 
 
 class FileDef(BaseModel):
     class Config:
         extra = Extra.allow
 
-    path: Optional[str] = None
-    content: Optional[str] = Field(
-        None, description="The raw content of the file to use"
-    )
-    source: Optional[SourceDef] = None
-    encoding: Optional[Encoding] = "plain"
-    group: Optional[str] = Field(
+    path: str | None = None
+    content: str | None = Field(None, description="The raw content of the file to use")
+    source: SourceDef | None = None
+    encoding: Encoding | None = "plain"
+    group: str | None = Field(
         "root",
         description="UNIX group name or GID owner of the file. Default to root(0)",
     )
-    owner: Optional[str] = Field(
+    owner: str | None = Field(
         "root", description="UNIX user or UID owner of the file. Default to root(0)"
     )
-    mode: Optional[str] = Field("0644", description="UNIX file mode")
-    context: Optional[Context] = "plain"
-    ignore_if_failed: Optional[bool] = Field(
+    mode: str | None = Field("0644", description="UNIX file mode")
+    context: Context | None = "plain"
+    ignore_if_failed: bool | None = Field(
         False,
         description="Whether or not the failure to retrieve the file should stop the execution",
     )
-    commands: Optional[Commands] = None
+    commands: Commands | None = None
+
+
+class Model(BaseModel):
+    files: dict[str, FileDef]
+    certificates: Certificates | None = None
+    iam_override: IamOverrideDef | None = Field(None, alias="IamOverride")