V.0.2 - Implementación del indicador Diversidad de Contribuciones, Grupo 13 (Antonio Muñoz Santiago y Manuel Fernández Giráldez) #250
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
manfergir
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Se ha llevado a cabo la implementación y verificación del indicador Diversidad de Contribuciones al repositorio, así como de las métricas totalCommitsPerUserLastYear y totalLinesPerUserLastYear, que representan el número de commits y el número de líneas modificadas por contribuyente en el último año.
La implementación de las métricas se ha realizado modificando la clase GitHubRepositoryEnquirerTest (tras realizar los test correspondientes), añadiendo dos métodos para la obtención de las métricas mencionadas anteriormente a través de la GitHub API de Koshuke. Los reportes que devuelven cada método están estructurados como un HasMap con el formato {"Nombre contribuidor": número de commits/líneas en el último año}.
La implementación del indicador se ha realizado creando una nueva clase: DiversityOfContributionsStrategy (tras realizar los test correspondientes), dónde se analizan los reportes de las métricas necesarias y se realiza la operación necesaria para su cálculo. Nótese que esta, la versión definitiva, difiere de la definición inicial entregada anteriormente. Se han eliminado métricas que se consideraban redundantes: el número de commits y líneas totales modificadas durante el último año se pueden obtener a partir de las métricas definitivas. La nueva versión está disponible en:
definicion_indicador.pdf
La implementación de los test de las métricas se ha realizado a través de la creación de dos métodos de test en la clase GitHubRepositoryEnquirerTest. Estos test han sido realizados por Manuel Fernández Giráldez previamente a la implementación de las métricas.
La implementación de varios test para el indicador se han realizado creando una nueva clase DiversityOfContributionsStrategyTest. Estos test comprueban, mediante el uso de Mocks del paquete Mockito, que el indicador se calcula correctamente siempre que reciba las métricas necesarias en el formato esperado. Adicionalmente, se comprueba que el indicador no se calcula si no adquiere todas las métricas necesarias, y que lanza correctamente la excepción NotAvailableMetricException. Estos test han sido realizados por Antonio Muñoz Santiago previamente a la implementación del indicador.