Rename "audit" to "fixity" across the codebase

[mjgiarlo]

Issue by mjgiarlo Monday Nov 14, 2016 at 16:45 GMT Originally opened as https://github.com/projecthydra/sufia/issues/2878

---

We use the term "audit" in the Sufia and CC codebases to refer to Fedora fixity checks, and this causes users confusion. See the UI screenshot below.

What do y'all think about renaming instances of "audit" to "fixity" in the codebases, @projecthydra/sufia-code-reviewers @jcoyne @cam156 @hackmastera ?

Also, does this need to wait 'til 8.0.0? See code screenshots below to get a sense of where and how "audit" is currently used.

Thanks to @electrickite for reporting this.

UI screenshot

Sufia code screenshot

CC code screenshot

[mjgiarlo]

Comment by hackmastera Monday Nov 14, 2016 at 16:49 GMT

---

What do people think it means?

[mjgiarlo]

Comment by mjgiarlo Monday Nov 14, 2016 at 16:50 GMT

---

@hackmastera This: https://wiki.duraspace.org/display/FEDORA4x/Optional+-+Audit+Service

[mjgiarlo]

Comment by hackmastera Monday Nov 14, 2016 at 16:52 GMT

---

That makes sense.

[mjgiarlo]

Comment by cam156 Monday Nov 14, 2016 at 17:21 GMT

---

@mjgiarlo I wonder if a user would make the distinction, since they have no knowledge of Fedora. Would it be worth documenting what we mean by Audit instead of making the change in the code?

[mjgiarlo]

Comment by mjgiarlo Monday Nov 14, 2016 at 17:29 GMT

---

@cam156 The tricky bit is that we can't assume Sufia users have no knowledge of Fedora. That is certainly true in IR-y contexts (ScholarSphere). It's less true in other use contexts.

[mjgiarlo]

Comment by escowles Monday Nov 14, 2016 at 17:38 GMT

---

I agree calling this fixity instead of audit would be less likely to cause confusion with the Fedora audit functionality.

[mjgiarlo]

Comment by electrickite Monday Nov 14, 2016 at 18:08 GMT

---

I don't have strong feelings one way or another. As a developer of a Sufia application, the term "audit" confused me because Fedora also uses that term in a different context. I've needed to develop more than a passing familiarity with Fedora during the course of development, so I wasn't sure initially what the Audit functionality in Sufia was referring to.

I think documentation of the Audit feature would go a long way toward alleviating any confusion. To me, documentation seems more important than changing class/method names to clarify intent.

[mjgiarlo]

Comment by mjgiarlo Monday Nov 14, 2016 at 18:34 GMT

---

@electrickite I'll be working on documentation changes today. The code changes above might not happen for months if we feel they're backwards-incompatible enough to warrant a major version bump. Thx!

[mjgiarlo]

Comment by hackmastera Monday Nov 14, 2016 at 18:38 GMT

---

You could change the labels to say "fixity audit" instead of just audit. I think all the code changes would be backwards-incompatible.

[mjgiarlo]

Comment by mjgiarlo Monday Nov 14, 2016 at 19:17 GMT

---

In the meantime, I've written some documentation around this: https://github.com/projecthydra/sufia/wiki/Sufia-Management-Guide#fixity-checking

:arrow_up: needs testing and verification.

[mjgiarlo]

Comment by electrickite Tuesday Nov 15, 2016 at 14:32 GMT

---

@mjgiarlo I tried the steps mentioned in your wiki post and, while they appear correct, the audit process itself seems to have a number of bugs. Running audit_everything crashes in some cases and does not produce any results in the UI. I'll write that up in a separate issue, though, since it is not directly related to renaming/documentation.

[mjgiarlo]

Comment by electrickite Tuesday Nov 15, 2016 at 14:59 GMT

---

Filed #2886 and https://github.com/projecthydra/curation_concerns/issues/1091 with more details of the problems I ran across.

[mjgiarlo]

Comment by mjgiarlo Tuesday Nov 15, 2016 at 15:06 GMT

---

Thanks, @electrickite!

[mjgiarlo]

Comment by mjgiarlo Tuesday Dec 20, 2016 at 23:15 GMT

---

I suggest we move this to Hyrax and work on it for the (eventual, not currently planned) 2.0 release.