From 79649e639b026d76ac60e5f97362ee9d4be69734 Mon Sep 17 00:00:00 2001 From: JJ Merelo Date: Thu, 14 Nov 2024 19:47:43 +0100 Subject: [PATCH] =?UTF-8?q?:coffin:=20experimento=20fallido=20que=20no=20s?= =?UTF-8?q?egu=C3=AD=20por=20alguna=20raz=C3=B3n?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- documentos/objetivos/0.Infraestructura.md | 469 ---------------------- documentos/objetivos/1.Planificacion.md | 31 -- documentos/objetivos/README.md | 3 - 3 files changed, 503 deletions(-) delete mode 100644 documentos/objetivos/0.Infraestructura.md delete mode 100644 documentos/objetivos/1.Planificacion.md delete mode 100644 documentos/objetivos/README.md diff --git a/documentos/objetivos/0.Infraestructura.md b/documentos/objetivos/0.Infraestructura.md deleted file mode 100644 index 8ac8efd3..00000000 --- a/documentos/objetivos/0.Infraestructura.md +++ /dev/null @@ -1,469 +0,0 @@ -# Iniciando un proyecto en la nube - - - -
- -## Objetivos - -### Cubre los siguientes objetivos de la asignatura - -1. Conocer los conceptos relacionados con el proceso de virtualización - tanto de software como de hardware y ponerlos en práctica. - -2. Justificar la necesidad de procesamiento virtual frente a real en el - contexto de una infraestructura TIC de una organización. - -### Objetivos específicos - -1. Entender la necesidad de infraestructura virtual en un contexto - moderno de desarrollo de aplicaciones. - -2. Asimilar los diferentes conceptos de las metodologías de desarrollo - enfocadas a infraestructuras virtuales. -
- -## GitHub y git - -Git es una herramienta para gestionar flujos de trabajo y equipos, y en -combinación con GitHub/GitLab es imprescindible para gestionar los procesos de -calidad del software que vamos a ver en este curso. - -Comencemos con la creación del repositorio. Primero, haz las -siguientes tareas para configurar correctamente git y GitHub. - -* [Configura el usuario, correo electrónico y editor](https://git-scm.com/book/es/v2/Inicio---Sobre-el-Control-de-Versiones-Configurando-Git-por-primera-vez) - de alguna de las formas posibles. -* [Crea un par clave pública/privada](https://docs.github.com/es/github/authenticating-to-github/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) - y súbela a tu perfil en GitHub. - -A partir de ahí, vamos a empezar a trabajar con un repositorio directamente. Lo -más rápido es crear repositorios directamente en GitHub - -> A partir de ahora, cuando diga GitHub se entenderá el sitio web que -> uses para alojar tus repositorios, GitHub, GitLab, BitBucket o el -> que corresponda; en algunos casos las características podrán no -> estar disponibles. - -Hay tres formas de crearlos: directamente (opción *New repository*) -desde el menú, haciendo un *fork* o copia de un repositorio existente -(lo que se aconseja, principalmente, si vas a trabajar con ese -repositorio) o bien creándolos a partir de una plantilla o -*template*. Esto sólo se puede hacer con repositorios que han sido -marcados para ello, como -[el repositorio de este otro curso](https://github.com/JJ/curso-qa-template); -si lo permite, la opción *Use this template* te permitirá crear tu -propio repositorio usando los ficheros existentes. Esta opción tiene -la ventaja de que el repositorio no aparece como un *fork*, y además -tienes una serie de ficheros para comenzar rápidamente. - -> Aconsejamos también que se instale [`hub`](https://hub.github.com/), -> la línea de órdenes de GitHub. Con ella se puede acceder -> directamente, desde git, a funcionalidades del propio GitHub; por -> ejemplo, descargar repos sólo con el nombre, o acceder a issues. - -Una vez creado el repositorio, se descarga con - -~~~shell -git clone mirepo # Si tienes hub instalado -git clone git@github.com:minick/mirepo -~~~ - -El [ciclo básico de git](http://mini-git.github.io/) consiste en usar -`add`, `push`, `pull` y `commit`. No vamos a entrar demasiado en eso, -pero deberías saber cómo usarlos. Sí vamos a ver flujos de trabajo -basados en pull requests y dedicar un poco de espacio al formato de -los mensajes de commit. - -Los mensajes de commit son predicados (el sujeto es el cambio al que -se ha sometido), deben ser atómicos, referirse siempre a un issue (y -en GitHub puedes indicar qué issue simplemente con # + número del -mismo) y usar 50 caracteres si es una sola línea, o 50 + línea en -blanco + líneas de 80 caracteres si se trata de más líneas. - -Pero adicionalmente, puedes usar [una estructura -convencional](https://dev.to/colewalker/conventional-commits-the-future-of-git-32gg?signin=true) -para que sean más informativos y permitan, de un vistazo, saber qué es lo que -hacen y a qué se refieren. También puedes usar -[*gitmojis*](https://gitmoji.dev/), símbolos que se introducen en un commit -entre dos puntos; por ejemplo, :+1: sería el símbolo del pulgar hacia arriba o -`:see_no_evil:` el que se usa cuando se añade algo al fichero `.gitignore`. Pero -se pueden usar muchos otros gitmojis, y os animo a que lo hagáis, porque -permiten, de un vistazo, saber de qué va el commit. - -## El fichero `.gitignore` y su importancia - -Ya que mencionamos el fichero `.gitignore`, más allá de ser algo que -evita la molestia de que aparezcan en el status cosas que en realidad -no nos interesan, es verdaderamente parte integral de la seguridad de -una aplicación. Para empezar, hay que tener en cuenta que afecta a el -directorio en el que se encuentra y todos los que hay por debajo; por -eso es habitual tener un .gitignore en el directorio raíz. Pero -también se pueden crear en subdirectorios específicos si esos -subdirectorios usan un lenguaje diferente o simplemente hay ficheros -en ellos que no nos interesa que estén. - -De forma general, en .gitignore estarán todos los ficheros generados, -pero también conviene añadir cosas como: - -* Los ficheros del IDE que estemos usando, por ejemplo, `.idea` o - `.vscode`. Estos ficheros contienen *setups* específicos de nuestro - ordenador, aparte de configuraciones que no interesa que tenga todo - el equipo. - -* Fichero `.env` donde se ponen valores de variables de entorno, - incluyendo claves de API y demás que se vayan a usar en el - despliegue. La buena práctica en este sentido es usar siempre el - mismo nombre de fichero, y que ese nombre de fichero esté en el - `.gitignore` de la plantilla del repositorio de la empresa o - *squad*. - -## Pulls y sus diferentes modalidades - -Como `git` es un sistema de control de versiones distribuido, `pull` -(y `push`) son los que permiten fusionar las historias de diversas -procedencias. En general, debemos imaginarnos estas dos historias como -dos ramas (literalmente, son ramas) de un árbol que, en un momento -determinado, divergieron. Esas ramas tienen una serie de *nudos*, que -son los commits. Fusionar implicar "ordenar" todos los nudos -procedentes de las dos ramas en una sola rama, de forma que se -incorporen las modificaciones de los dos lados. Vamos a imaginar por -lo pronto que no hay ningún tipo de conflicto. Hay tres formas de -hacer esto - -* *Squash* y fusionar. A veces la rama que uno quiere fusionar (de la - que va a hacerse pull) tiene un montón de commits, algunos de los - cuales pueden deshacer trabajo hecho anteriormente, o simplemente - eliminar texto de depuración. Hacer *squash* convierte todos los - commits en uno solo, y te reúne todos los mensajes de commit de - forma que puedas editarlos, o borrarlos, para dejar sólo los que - sean relevantes al resultado final. - -* *Merge commit* en este caso se crea un commit específico que dice - que se han mergeado, y se re-firman los commits existentes con la - firma de quien lo acepta. De todas las opciones, esta es la que se - debe de tratar de *no* usar, salvo que haya un modelo de desarrollo - con una sola persona encargada de trabajar con la rama principal. - -* *Rebase and merge* en este caso no se crea un merge commit, se - aplican los commits de la rama, y encima se aplican los commits - propios desde donde hayan divergido. Se reescribe la historia del - repositorio de forma que provoque los mínimos problemas. - -Pero ¿qué pasa si hay conflictos? El flujo de trabajo debe funcionar -de forma que los conflictos se minimicen, con diferentes personas -trabajando en diferentes partes del código. En ese caso mi experiencia -es que es mejor optar por el merge commit, porque creará marcas en el -fichero del conflicto que indiquen las dos versiones. En muchos casos -no hay más remedio que mirar el código y tomar la versión que -funcione; en otros casos, si sabemos que la versión buena es una de -ellas, hacer - -```shell -git checkout --theirs fichero -git checkout --ours fichero -``` - -En el primer caso la versión buena será la del repo del que estás -haciendo pull, en el segundo la del propio. - -## Pull requests - -Los *pull requests* (o *merge requests* en GitLab) son "peticiones de -pull" o peticiones de incorporación a otro repositorio, es decir, una -forma de indicarle a quien tenga permisos en repo que se quiere -incorporar un cambio a la rama principal. Lo bueno es que GitHub te -provee un interfaz gráfico para interaccionar con el cambio y también -la persona que lo hace. Para empezar, se pueden crear plantillas en el -repositorio en el cual se dé una estructura al pull request, tal como -decir qué necesidad cubre o marcar si se han cumplido una serie de -condiciones; a posteriori se puede comprobar, usando sistemas de -integración continua, si se han cumplido esas condiciones. - -Por eso, un pull request es una ocasión para revisar el -código. *Siempre* hay que mirarlo, incluso aunque haya pasado los -tests; puede haber mejoras que se pueden hacer sobre la marcha, en la -rama desde la que se solicita el pull request. Pero lo principal de -los mismos es que pueden limitarse para que no se pueda fusionar si no -hay más de un número determinado de aceptaciones, por ejemplo. Eso -anima al desarrollo colaborativo y permite comprobar la calidad del -código como sólo los humanos saben hacerlo. Un flujo de trabajo en -dónde sólo se acepta a la rama principal desde un pull request permite -reducir la cantidad de errores y por tanto, desde el mismo origen, -trabajar en la calidad del producto resultante. - -Los PRs, igual que todos los push a la rama principal, pueden ir -acompañados de una serie de tests específicos. Veremos más adelante en -qué consisten y cómo programarlos. - -## Trabajando con ramas - -En general, cualquier proyecto va a trabajar usando ramas como -principal "lugar" de trabajo. En general, se desarrollará en una rama -(siguiendo una historia de usuario, como se verá más adelante) y esa -rama se incorporará a la principal tras la revisión por el resto del -equipo. - -Es conveniente que los nombres de las ramas sigan una serie de -reglas, entre otras cosas porque el título del pull request que se -haga se creará a partir de ese nombre. Y en muchos casos esos nombres -vendrán dados automáticamente por el sistema en el que se esté -trabajando, tal como Jira, por ejemplo. En todo caso, suelen seguir la -convención `xxx/yyy/zzz`. En algún lado, y generalmente al final, debe -haber algo que refleje qué es lo que hace la rama. Algunas -convenciones que se pueden usar razonablemente son - -* `usuario/titulo-del-issue`, por ejemplo `JJ/añade-hook`. Así queda - claro que es algo que uno está haciendo, y de qué va el tema. -* Jira (del que oiremos hablar mucho) usa cosas un poco más - complicadas, del tipo `tipo/proyecto/issue/tarea`, por ejemplo - `fix/HOOK/333/web-service` que estaría trabajando sobre el ticket - HOOK-333 que sería un *fix* o arreglo (puede ser una `story` o un - `epic`, u otro tipo a medida que se haya creado). - -Un nombre de rama razonable indicará a todo el mundo del equipo qué es -lo que se está haciendo; y esto es importante porque siempre se -programa para el futuro y para el equipo, no para uno mismo. - -Recordad que para crear la rama, hacer push por primera vez a ella y -en las veces sucesivas, habrá que hacer: - -```shell -git checkout -b JJ/añade-hook -git push -u origin JJ/añade-hook # crea la rama remota y la asocia a esta -git push origin JJ/añade-hook -``` - -Como truco, se puede usar - -```shell -git push origin $(git describe --contains --all HEAD) -``` - -que pusheará a la rama en la que se encuentre uno en ese momento (con -`-u` si se trata de crear la rama remota) - -## *Tagging* y *releasing* - -En el ciclo de vida de una base de código, los *releases* son puntos -de control que se alcanzan al final de algún hito. Estos puntos de -control permiten saber exactamente el estado de la base de código en -ese momento, e incluso volver a ellos si hace falta corregir algún -error. - -En git se marcan los releases con un *tag*, que es simplemente una -anotación (o etiqueta) que se añade a un commit determinado; es, por -tanto, una forma de recordar un commit para volver a él si hace falta, -o simplemente recuperar todos los ficheros en el estado que estaban en -ese commit para hacer un release o un despliegue con todos ellos. - -Para marcar, se usa `git tag` - -```shell -git tag -a v0.0.1 -m "First release" -``` - -Tras la `a` se pone la versión, generalmente con una v delante, y -usando "versionado semántico", donde el primer número suele -corresponder a una "major", el siguiente a una "minor", y el siguiente -a *point releases* o versiones que mejoran algo sin hacer ninguna -alteración al API. - -A partir de ese tag, en GitHub se pueden crear *releases* desde la -línea de órdenes o desde la web; estas releases crearán en la web un -paquete con los ficheros, pero adicionalmente se pueden añadir otros -ficheros binarios. *Todos* los ficheros generados deben ir en -releases, *no* en el repositorio; por ejemplo, PDFs o `.deb`. - -Una vez constituido un release con un tag, equivale a una rama ligera; -se puede acceder al commit etiquetado con - -```shell -git checkout v0.0.1 -``` - -En realidad, se habrá obtenido el estado del repositorio tras un -commit determinado, por lo que se quedará en una situación llamada -*detached HEAD*, no asociado a ningún extremo del grafo de commits. Si -se quiere trabajar a partir de ahí (para corregir un bug, por -ejemplo), habrá que crear una rama a partir de ese commit: - -```shell -git checkout -b rama-desde-tag -``` - -Esa rama podemos usarla como cualquier otra rama, desplegarla o -fusionarla eventualmente con `master`. - -## Planteando un proyecto: buscando la clientela - -En muchos casos en informática, y en muchos a los que nos vamos a -enfrentar durante la carrera y, sobre todo, si queremos emprender o -crear alguna cosa totalmente nueva (o presentar un proyecto al -concurso, que para el caso es lo mismo) el principal problema al que -nos vamos a enfrentar es no encontrar ideas para iniciar el proyecto, -o no saber qué problema más o menos cercano o presente podríamos -resolver. - -Sobre todo en emprendimiento, pero también en Informática, se puede -emplear, la mayoría de veces con éxito, la metodología de [*design -thinking*](https://www.designthinking.es/inicio/). - -Es una metodología más o menos establecida, pero esencialmente se -parte de una estadística, un dato o un artículo, y a partir de ahí, en -diferentes fases, se van definiendo posibles soluciones al -problema. En la fase de ideas, la que nos interesa es la fase que se -denomina -[*empatizar*](https://designthinkingespaña.com/empatizar-primera-fase-design-thinking), -es decir, colocarse en el lugar de los futuros -usuarios para ver qué deseos tienen y cual sería la mejor forma de -canalizar esos deseos y lograr resolverlos con una aplicación. - -### Ejemplo - -En el caso de un hipotético *dashboard* para controlar los proyectos de -los estudiantes, el principal problema que se puede plantear es lo -manual y tedioso que puede ser controlar uno por uno todos los -proyectos. Empatizar permite centrar el diseño en el usuario, -simplificar el desarrollo al no responder a necesidades que no se -soliciten, y crear un marco en el cual se va a desarrollar esta -aplicación. Además, también permite identificar los *actores*, o -quienes son los que van a usar efectivamente la aplicación. - -## Empatizando con los clientes - -Es esencial en la elaboración de un proyecto saber quién lo va a usar, -pero saberlo hasta el último detalle. Diseñar el interfaz de usuario -requiere saber el tipo de usuario y tener en cuenta la [accesibilidad -universal](https://www.fundacioncaser.org/autonomia/cuidadores-y-promocion-de-la-autonomia/promover-la-autonomia-personal/que-es-la-accesibilidad-universal), -pero la eficacia en que el destinatario final del software lleve a -cabo las labores que se pueden hacer con el mismo es esencial. - -En un marco de *design thinking*, además, se habrá identificado a los -actores desde el principio. En esta fase se definirán un poco más, de -forma que pueda acercarse a lo que necesitamos saber de ellos para -desarrollar nuestro software. - -Y la cuestión es que rara vez se trata de un solo tipo de -usuario. Aparte de las labores "clásicas", "usuario" y -"administrador", y también el "programador/a" que será quien escriba -el código, todos los roles necesitan ser definidos claramente en -función de sus capacidades motoras y cognitivas, o simplemente -preferencias culturales o lingüísticas. - -> ¿Alguien tiene en cuenta a la hora de diseñar una aplicación que -> eventualmente vaya a ser usada por personas con diferentes idiomas -> nativos? Pues eso. - -En desarrollo ágil, por tanto, se usa la metodología llamada -[personas](https://www.fundacioncaser.org/autonomia/cuidadores-y-promocion-de-la-autonomia/promover-la-autonomia-personal/que-es-la-accesibilidad-universal) -(en inglés es igual), que consiste simplemente en dar nombre, -apellidos, edad y una biografía e incluso currículum a los posibles -usuarios del software. De esa forma, no va a haber "usuario avanzado", -sino "Doris Yllana McKenzie, máster en ciencia de datos, 35 años, -residente en Tres Cantos, Madrid. - -Los personajes o *personas* creadas servirán como protagonistas de las -historias de usuario, que siempre tendrán la forma *como [rol] quiero -que en un [contexto] se obtenga [resultado] o si no [otro -resultado]*. En general, las HUs serán una expresión de alto nivel de -los deseos de todos los posibles clientes de nuestro software. - -### Ejemplo 2 - -Hemos venido trabajando con una aplicación que intenta monitorizar las -diferentes etapas en las que se encuentran los proyectos de -estudiantes de una carrera de informática. - -Para crear la "persona" conviene que se investigue un poco el posible -usuario, usando estadísticas publicadas. - -> He intentado buscar estadísticas de la UGR sobre edad media por -> disciplinas, y no la he encontrado. La publicación de datos, y más -> de datos abiertos, es un gran fail. - -Por ejemplo, la edad mediana del profesorado de informática en la UGR está -entre los 50 y 60 años. - -> Parece mentira, pero es así. Yo estoy ligeramente por debajo de la -> mediana. - -En informática, la mayoría del profesorado es hombre. Salvo que -queramos proyectar un mensaje (que también es posible), se debe tratar -de usar estas estadísticas en el diseño de las personas. - -Finalmente, el profesorado tiene, en general, un doctorado y es de -origen español (una minoría de otros países de habla hispana, como -Cuba y Argentina). Con lo que ya tenemos definida la persona: - -> Iris Capuleto Troya, con nacimiento en España en 1967, licenciatura -> en Informática y doctorado en Informática por la UGR, habla español -> correctamente, también inglés (nivel B1), usa gafas bifocales y -> tiene tanto portátiles como tablets como móviles de última -> generación. - -Es decir, cuando decidamos a partir de ahora crear HUs, hablaremos de -"Iris quiere" o "Iris desea". Lo haremos en el material del curso, -dentro de la medida de lo posible. - -## Soporte para documentación - -La documentación de un proyecto es la mejor garantía de que todo el -mundo entiende qué se está haciendo y por qué. Se tienen que -documentar tanto las decisiones tomadas como el proceso que ha llevado -a esa toma de decisiones. Lo que se persigue con esta externalización -de las decisiones es que la decisión de si un código es correcto o no -no dependa de una persona: depende de las decisiones tomadas por el -equipo, y documentadas correctamente. - -Los mejores sistemas de documentación tienen plantillas para las -decisiones tomadas de forma más habitual por un equipo, desde las -"Personas" hasta las decisiones de arquitectura (que se incluyen en -las llamadas ADR, *architecture decision records*). Sistemas como -Confluence de Atlassian, que se usa en la mayoría de las empresas, son -de este tipo. A falta de este tipo de plantillas, el wiki de GitHub o -GitLab vale exactamente lo mismo, siempre que en la cabecera dejéis -bien claro de qué se trata. - -Adicionalmente, ya desde la etapa de documentación conviene que se -organice un poco y se estructure el proceso. Aunque más adelante se -verá con un poco más de profundidad, los sistemas mencionados -anteriormente tienen alguna forma de documentar lo que todavía está en -la fase de "idea". En Confluence hay páginas que son tal cual, en -GitHub se puede abrir un "Proyecto" tipo "kanban" y usar la columna de -"ideas" para organizar lo que se está haciendo. Desde esta columna se -pueden enlazar las entradas del wiki correspondientes, si se desea. - -En este tipo de herramientas, lo mejor es la consistencia y que estén bien -conectadas unas con otras. Mi consejo es que si se usa GitHub, se use para todo; -si se usa [Jira](https://www.atlassian.com/es/software/jira), un sistema de -órdenes de trabajo (*issues* o *tickets*) o -[Confluence](https://www.atlassian.com/es/software/confluence), bueno, conviene -al menos que se vinculen. - -## Ver también - -En el capítulo dedicado a [integración -continua](https://jj.github.io/curso-tdd/temas/CI) dedicamos una -sección a los *hooks* o ganchos de git, scripts que se ejecutan -automáticamente alrededor de órdenes de git tales como `commit` o `push`. - -GitHub (y posiblemente GitLab) se puede conectar fácilmente a sistemas -de mensajería tales como Telegram o Slack, de forma que todos los -cambios (o la mayoría; algunos puede que no vayan, como etiquetar un -issue) vayan a parar a un grupo elegido; -[GitHubBot](https://www.integromat.com/en/integrations/github/telegram) -hace esa labor. Para un grupo de trabajo lo mejor es crear un grupo de -Telegram y añadir el bot al ese grupo para que comunique todos los -cambios; adicionalmente, si todos los miembros del grupo autorizan al -bot a acceder al API en su nombre, se podrá interaccionar con GitHub -directamente desde el grupo de Telegram. - -[Un artículo da consejos para crear una serie de personas -creíbles](https://www.romanpichler.com/blog/10-tips-agile-personas/). - -## Objetivo correspondiente - -Tras mirar esto, se puede avanzar al [objetivo 0](../proyectos/0.Repositorio.md) diff --git a/documentos/objetivos/1.Planificacion.md b/documentos/objetivos/1.Planificacion.md deleted file mode 100644 index c64586f2..00000000 --- a/documentos/objetivos/1.Planificacion.md +++ /dev/null @@ -1,31 +0,0 @@ -# Planificando un proyecto - - - -
- -## Objetivos - -### Cubre los siguientes objetivos de la asignatura - -1. Conocer los conceptos relacionados con el proceso de virtualización - tanto de software como de hardware y ponerlos en práctica. - -2. Justificar la necesidad de procesamiento virtual frente a real en el - contexto de una infraestructura TIC de una organización. - -### Objetivos específicos - -1. Entender la necesidad de infraestructura virtual en un contexto - moderno de desarrollo de aplicaciones. - -2. Asimilar los diferentes conceptos de las metodologías de desarrollo - enfocadas a infraestructuras virtuales. - -
- -## A dónde ir desde aquí - -A la charla de [servicios web](https://jj.github.io/pilas/#/), por ejemplo. diff --git a/documentos/objetivos/README.md b/documentos/objetivos/README.md deleted file mode 100644 index d1242c00..00000000 --- a/documentos/objetivos/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Objetivos IV - -Material adaptado a cada uno de los objetivos que componen la asignatura.