Translation(s): none

These user stories have been set up to check that our documentation answers all possible probable issues which users, contributors, maintainers might face with AppArmor in Debian.

   1 Feature: Ship an existing AppArmor profile confining software S in the Debian package that ships S
   2   Scenario:
   3     As a Debian package maintainer,
   4     When I want to ship an AppArmor profile in package P, 
   5     Given this profile exists upstream or in the apparmor-profiles-extra package
   6     Then I need to be told how to do that.
   7 

→ Usertag: "new-profile"

→ Usertag: "migrate-profile"

→ Documentation: AppArmor/Contribute/FirstTimeProfileImport

→ Documentation: AppArmor/Contribute/ImportProfileFromExtra

   1 Feature: Testing AppArmor confinement before uploading a new version of a package
   2   Scenario:
   3     As a Debian package maintainer,
   4     Given I ship an AppArmor profile in package P, 
   5     When I prepare an upload for a new upstream release,
   6     Then I want to check that it still works under AppArmor confinement. 
   7 

→ Documentation AppArmor/Debug

   1 Feature: New AppArmor profile
   2   Scenario:
   3     As a Debian package maintainer or as a Debian contributor,
   4     Given that I have written or found an AppArmor profile for package P, 
   5     And this profile does not exist in apparmor-profiles-extra nor upstream,
   6     Then I need to be taught how to test the profile
   7     And I need to be taught to ask for a review of this profile
   8     And I need to be taught how to upstream this profile
   9 

→ Usertag "new-profile"

→ Documentation AppArmor/Debug

→ Documentation: AppArmor/ContributeUpstream

   1 Feature: Update an AppArmor profile to include upstream improvements
   2   Scenario:
   3      As a Debian user or contributor,
   4      When I want an already packaged profile to be updated to the latest upstream version
   5      Then I need to be taught how to make the AppArmor team aware of my needs.
   6 

→ Usertag "merge-from-upstream"

→ Usertag "patch" with attached patch

→ Documentation: Updating a profile in Debian’s apparmor-profiles-extra package

   1 Feature: Modify an already shipped AppArmor profile
   2   Scenario:
   3      As a Debian contributor,
   4      Given that an AppArmor profile is shipped in package P
   5      When I want to update that profile 
   6      And changes should be merged upstream and in the Debian package
   7      Then I need to know how to do that.
   8 

→ Usertag "modify-profile"

   1 Feature: Upstream Debian changes made on an AppArmor profile we ship
   2   Scenario:
   3      As a Debian contributor,
   4      When I want to request that a profile which is shipped in Debian be updated upstream
   5      Then I need to be taught how to do that.
   6 

→ Usertag "merge-to-upstream"

Documentation AppArmor/Contribute/Upstream

   1 Feature: Find out if a problem with a confined software is AppArmor related
   2   Scenario:
   3       As a Debian user,
   4       Given I use a program that comes with an AppArmor profile,
   5       When this software does not behave as it should or crashes,
   6       Then I want to be taught how to diagnose whether AppArmor is involved
   7       And if that is the case, I want to be taught what to include in a bugreport and how I could fix the problem myself.
   8 

→ Usertag "help-needed", to request help for initial diagnosis

→ Usertag "buggy-profile" if AppArmor has been identified as culprit

→ Documentation: AppArmor/Reportbug

→ Documentation: AppArmor/Debug

   1 Feature: Find out if a bug is AppArmor related
   2   Scenario:
   3      As a Debian package maintainer,
   4      Given I ship an AppArmor profile in package P I am maintaining, 
   5      When I receive a bug report that might be caused by AppArmor, 
   6      Then I want to be taught how to diagnose whether AppArmor is involved
   7      And if that is the case, I want to be taught how to put the problem under the pkg-apparmor team's radar.
   8 

→ Usertag "help-needed", to request help for initial diagnosis

→ Documentation: AppArmor/Debug

→ Usertag "buggy-profile" if AppArmor has been identified as culprit

   1 Feature: Other AppArmor related problems
   2    Scenario:
   3      As a Debian user or contributor, 
   4      When I encounter problems with any AppArmor related tools (systemd, auditd, syslog, etc.),
   5      And I submit a bug report,
   6      Then I want to make the team aware of those bugs.
   7 

→ Usertags: will be refined as we go

→ Documentation: AppArmor/Reportbug

→ Currently, there is a usertag called "ux" for a bug related to auditd's formatting of AppArmor related messages and "platform" for #775331