AbsaOSS/enceladus

Refactor Validation Utils

Open

#57 opened on Dec 2, 2018

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Scala (16 forks)auto 404
Conformancegood first issuepriority: undecidedrefactoring

Repository metrics

Stars
 (33 stars)
PR merge metrics
 (PR metrics pending)

Description

We have two separate ValidationExceptions:

  • za.co.absa.enceladus.conformance.interpreter.rules.ValidationException (only used in Standardization)
  • za.co.absa.enceladus.utils.validation.ValidationException (only used in Conformance) Conformance also dips into za.co.absa.enceladus.utils.validation.ValidationUtils before throwing its own ValidationException, which blurs the line between which ValidationException is responsible for what.

Good design dictates a clear separation between the two or a unification.

There is also some code duplication in conformance rules, specifically aimed at validation, that would best be extracted to a common location.

Contributor guide

Research direction
Identify the two ValidationException classes and their usages. Determine if they can be unified or need separation. Refactor to remove duplication.
Tech stack
scala
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65