Cosmos.EventSourcing.Template 0.2.7

Solution template: Cosmos EventSourcing

Descripción

Nuget de Plantilla de solución para event sourcing.

Construye los siguientes proyectos:

• Dominio: Contiene los agregados, comandos, eventos, commandHandlers.
• Consultas: Contiene las proyecciones, consultas y queryHandlers. Los modelos de consulta debería estar en dominio.
• Comandos.API: API REST para los comandos de la aplicación con minimal API, healthchecks y Open API.
• Consultas.API: API REST para los comandos de la aplicación con minimal API, healthchecks y Open API.
• Dominio.Tests: Abstracción del StoreEvent para pruebas y CommandHandlerTest.
• Consultas.Tests: Pruebas conectadas para las proyecciones con un demonio de Marten y postgres TestContainers.
• AcceptanceTests: Proyecto de pruebas de integración que ejecutan la API de Comandos o consultas y una base de datos con TestContainers.

Cómo publicar una nueva versión de la plantilla

Antes de realizar la publicación del nuget, le sugerimos que primero realice las pruebas locales de la plantilla.

Tenga en cuenta que el código fuente de la plantilla se encuentra en el diretorio template. Fuera de esta carpeta está solo la información concerniente a la generación del paquete Nuget.

Instalar la versión del nuget en local

Crear el paquete (.nupkg)

Ubíquese en el directorio raíz del proyecto y ejecute el siguiente comando:

dotnet pack Cosmos.EventSourcing.Template.csproj -c Release

El archivo del nuget package está en: bin\release\<Nombre plantilla.Version>.nupkg

Instale la plantilla local en el IDE

En Rider

1. Vaya a la opción para crear una nueva solución.
2. Haga clic en el vínculo Manage Templates..
3. Instalar la plantilla desde el local. Busca el archivo .nupkg dentro de la carpeta bin.
4. Con esto debe aparecer la plantilla en la sección Custom Templates del menú izquierdo de el modal nueva solución.

En Visual Studio

1. Desde la terminal, ubíquese en el directorio donde está el archivo .nupkg.
2. Ejecute el comando dotnet new install "Cosmos.EventSourcing.Template.<version>.nupkg"
3. En el modal de crear nuevo proyecto, ya estará disponible la plantilla. Recuerde usar el buscador con la palabra Cosmos

Publicar la nueva versión

⚠️ Esto solo es válido mientras configuramos el pipeline de despliegue en Azure.

La plantilla se publica en el feed de Cosmos en Azure DevOps. Para realiza esta tarea debe tener acceso a la organización Sincosoftsascosmos.

En el nuget.config de su usuario, el cual puede administrar desde su IDE, debe tener registrado el feed de Cosmos.

Configurar el feed de Cosmos en su computador

En caso de no haberlo realizado, le sugerimos:

1. Estando dentro de la organización de Azure DevOps, cree un Personal Access Token (PAT) que por lo menos tenga el permiso de Packaging en Read, write and manage

2. Instale el feed en el manejador de paquetes nuget dentro del IDE. El nuget package debio quedar con esta línea dentreo del xml:

    <packageSources>
        <add key="Cosmos" value="https://pkgs.dev.azure.com/sincosoftsascosmos/Nugets/_packaging/Cosmos.Packages/nuget/v3/index.json" />
        <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
        index.json" />
    </packageSources>
   

   El nombre Cosmos, fue el que se le dió al feed en el ejemplo, puede ser cualquier nombre, pero lo importante es que coincida con el nombre que se ponga en el packageSourceCredentials del siguiente punto.

   ⚠️ Asegúrese que el feed de cosmos esté antes de nuget.org.

3. En el archivo Nuget.Config, que está en el directorio AppData\Roaming\Nuget, dentro del directorio de su usuario de windows, adicione el siguiente tag, en caso que exista, solo cree el Tag Cosmos y llene su correo de Sincosoft y su PAT:

    <packageSourceCredentials>
        <Cosmos>
            <add key="Username" value="<correo de sincosoft>" />
            <add key="ClearTextPassword" value="<PAT>" />
        </Cosmos>
    </packageSourceCredentials>
   

Publicar la plantilla en el feed d Cosmos

❗Solo realice esta operación después de haber validado su plantilla en local

1. Realice el cambio de la versión en el archivo Cosmos.EventSourcing.Template.csproj

2. Cree el PR e integre el código fuente en el repositorio.

3. Dentro del directorio donde está el .nupkg ejecute el siguiente comando:

   ⚠️ Adevertencia:

   • El nombre del source debe coincidir con el nombre del feed que está en el Nuget.Config
   • El nombre del apikey debe coincidir con el packageSourceCredentials
   • El número de la versión debe coincidir con el archivo que está publicando y debe ser posterior a la última publicada.

   dotnet nuget push --source "Cosmos" "Cosmos.EventSourcing.Template.0.1.2.nupkg" --api-key "Cosmos"