Files
freeCodeCamp/curriculum/challenges/portuguese/06-quality-assurance/quality-assurance-projects/issue-tracker.md

14 KiB

id, title, challengeType, forumTopicId, dashedName
id title challengeType forumTopicId dashedName
587d8249367417b2b2512c42 Rastreador de problemas 4 301569 issue-tracker

--description--

Crie um aplicativo full stack em JavaScript que seja funcionalmente semelhante a este: https://issue-tracker.freecodecamp.rocks/. Trabalhar nesse projeto vai fazer com que você escreva seu código usando um dos seguintes métodos:

Quando terminar, certifique-se de que uma demonstração funcional do seu projeto está hospedada em algum lugar público. Em seguida, envie o URL para ela no campo Solution Link. Como opção, envie também um link para o código-fonte do projeto no campo GitHub Link.

--instructions--

  • Complete a rota /api/translate em /routes/api.js
  • Crie todos os testes funcionais em tests/2_functional-tests.js
  • Copie o arquivo sample.env para .env e defina as variáveis adequadamente
  • Para executar os testes, remova NODE_ENV=test dos comentários no seu arquivo .env
  • Para executar os testes no console, use o comando npm run test. Para abrir o console do Replit, pressione Ctrl+Shift+P (cmd, se estiver em um Mac) e digite "open shell"

Escreva os testes a seguir em tests/2_functional-tests.js:

  • Crie uma issue com cada campo: solicitação de POST para /api/issues/{project}
  • Crie uma issue somente com os campos obrigatórios: solicitação de POST para /api/issues/{project}
  • Crie uma issue com os campos obrigatórios ausentes: solicitação de POST para /api/issues/{project}
  • Veja as issues de um projeto: solicitação de GET para /api/issues/{project}
  • Veja as issues de um projeto com um filtro: solicitação de GET para /api/issues/{project}
  • Veja as issues de um projeto com vários filtros: solicitação de GET para /api/issues/{project}
  • Atualize um campo em uma issue: solicitação de PUT para /api/issues/{project}
  • Atualize vários campos em uma issue: solicitação de PUT para /api/issues/{project}
  • Atualize uma issue com o campo _id ausente: solicitação de PUT para /api/issues/{project}
  • Atualize uma issue sem campos para atualizar: solicitação de PUT para /api/issues/{project}
  • Atualize uma issue com o campo _id inválido: solicitação de PUT para /api/issues/{project}
  • Exclua uma issue: solicitação de DELETE para /api/issues/{project}
  • Exclua uma issue com um _id inválido: solicitação de DELETE para /api/issues/{project}
  • Exclua uma issue com o _id ausente: solicitação de DELETE para /api/issues/{project}

--hints--

Você pode fornecer seu próprio projeto, não o exemplo de URL.

(getUserInput) => {
  assert(!/.*\/issue-tracker\.freecodecamp\.rocks/.test(getUserInput('url')));
};

Você pode enviar uma solicitação de POST para /api/issues/{projectname} com dados de formulário que contém os campos obrigatórios issue_title, issue_text, created_by e, como opção, assigned_to e status_text.

async (getUserInput) => {
  try {
    let test_data = {
      issue_title: 'Faux Issue Title',
      issue_text: 'Functional Test - Required Fields Only',
      created_by: 'fCC'
    };
    const data = await $.post(
      getUserInput('url') + '/api/issues/fcc-project',
      test_data
    );
    assert.isObject(data);
    assert.nestedInclude(data, test_data);
  } catch (err) {
    throw new Error(err.responseText || err.message);
  }
};

A solicitação de POST para /api/issues/{projectname} retornará o objeto criado e deve incluir todos os campos enviados. Os campos opcionais excluídos serão retornados como strings vazias. Além disso, inclua created_on (data/hora), updated_on (data/hora), open (booleano, true para aberto - valor padrão, false para fechado) e _id.

async (getUserInput) => {
  try {
    let test_data = {
      issue_title: 'Faux Issue Title 2',
      issue_text: 'Functional Test - Every field filled in',
      created_by: 'fCC',
      assigned_to: 'Chai and Mocha'
    };
    const data = await $.post(
      getUserInput('url') + '/api/issues/fcc-project',
      test_data
    );
    assert.isObject(data);
    assert.nestedInclude(data, test_data);
    assert.property(data, 'created_on');
    assert.isNumber(Date.parse(data.created_on));
    assert.property(data, 'updated_on');
    assert.isNumber(Date.parse(data.updated_on));
    assert.property(data, 'open');
    assert.isBoolean(data.open);
    assert.isTrue(data.open);
    assert.property(data, '_id');
    assert.isNotEmpty(data._id);
    assert.property(data, 'status_text');
    assert.isEmpty(data.status_text);
  } catch (err) {
    throw new Error(err.responseText || err.message);
  }
};

Se você enviar uma solicitação de POST para /api/issues/{projectname} sem os campos obrigatórios, será retornado o erro { error: 'required field(s) missing' }

async (getUserInput) => {
  try {
    let test_data = { created_by: 'fCC' };
    const data = await $.post(getUserInput('url') + '/api/issues/fcc-project', {
      created_by: 'fCC'
    });
    assert.isObject(data);
    assert.property(data, 'error');
    assert.equal(data.error, 'required field(s) missing');
  } catch (err) {
    throw new Error(err.responseText || err.message);
  }
};

Você pode enviar uma solicitação de GET para /api/issues/{projectname} para um array de todas as issues para esse projectname específico, com todos os campos presentes para cada issue.

async (getUserInput) => {
  try {
    let test_data = { issue_text: 'Get Issues Test', created_by: 'fCC' };
    const url =
      getUserInput('url') +
      '/api/issues/get_issues_test_' +
      Date.now().toString().substring(7);
    const data1 = await $.post(
      url,
      Object.assign(test_data, { issue_title: 'Faux Issue 1' })
    );
    assert.isObject(data1);
    const data2 = await $.post(
      url,
      Object.assign(test_data, { issue_title: 'Faux Issue 2' })
    );
    assert.isObject(data2);
    const data3 = await $.post(
      url,
      Object.assign(test_data, { issue_title: 'Faux Issue 3' })
    );
    assert.isObject(data3);
    const getIssues = await $.get(url);
    assert.isArray(getIssues);
    assert.lengthOf(getIssues, 3);
    let re = new RegExp('Faux Issue \\d');
    getIssues.forEach((issue) => {
      assert.property(issue, 'issue_title');
      assert.match(issue.issue_title, re);
      assert.property(issue, 'issue_text');
      assert.property(issue, 'created_by');
      assert.property(issue, 'assigned_to');
      assert.property(issue, 'status_text');
      assert.property(issue, 'open');
      assert.property(issue, 'created_on');
      assert.property(issue, 'updated_on');
      assert.property(issue, '_id');
    });
  } catch (err) {
    throw new Error(err.responseText || err.message);
  }
};

Você pode enviar uma solicitação de GET para /api/issues/{projectname} e filtrar a solicitação também passando qualquer campo e valor como uma consulta de URL (ex.: /api/issues/{project}?open=false). É possível passar um ou mais campos/valores de uma só vez.

async (getUserInput) => {
  try {
    let test_data = {
      issue_title: 'To be Filtered',
      issue_text: 'Filter Issues Test'
    };
    const url =
      getUserInput('url') +
      '/api/issues/get_issues_test_' +
      Date.now().toString().substring(7);
    const data1 = await $.post(
      url,
      Object.assign(test_data, { created_by: 'Alice', assigned_to: 'Bob' })
    );
    const data2 = await $.post(
      url,
      Object.assign(test_data, { created_by: 'Alice', assigned_to: 'Bob' })
    );
    const data3 = await $.post(
      url,
      Object.assign(test_data, { created_by: 'Alice', assigned_to: 'Eric' })
    );
    const data4 = await $.post(
      url,
      Object.assign(test_data, { created_by: 'Carol', assigned_to: 'Eric' })
    );
    const getSingle = await $.get(url + '?created_by=Alice');
    assert.isArray(getSingle);
    assert.lengthOf(getSingle, 3);
    const getMultiple = await $.get(url + '?created_by=Alice&assigned_to=Bob');
    assert.isArray(getMultiple);
    assert.lengthOf(getMultiple, 2);
  } catch (err) {
    throw new Error(err.responseText || err.message);
  }
};

Você pode enviar uma solicitação de PUT para /api/issues/{projectname} com um _id e um ou mais campos para atualizar. Em caso de sucesso, o campo updated_on deve ser atualizado e deve ser retornado { result: 'successfully updated', '_id': _id }.

async (getUserInput) => {
  try {
    let initialData = {
      issue_title: 'Issue to be Updated',
      issue_text: 'Functional Test - Put target',
      created_by: 'fCC'
    };
    const url = getUserInput('url') + '/api/issues/fcc-project';
    const itemToUpdate = await $.post(url, initialData);
    const updateSucccess = await $.ajax({
      url: url,
      type: 'PUT',
      data: { _id: itemToUpdate._id, issue_text: 'New Issue Text' }
    });
    assert.isObject(updateSucccess);
    assert.deepEqual(updateSucccess, {
      result: 'successfully updated',
      _id: itemToUpdate._id
    });
    const getUpdatedId = await $.get(url + '?_id=' + itemToUpdate._id);
    assert.isArray(getUpdatedId);
    assert.isObject(getUpdatedId[0]);
    assert.isAbove(
      Date.parse(getUpdatedId[0].updated_on),
      Date.parse(getUpdatedId[0].created_on)
    );
  } catch (err) {
    throw new Error(err.responseText || err.message);
  }
};

Quando a solicitação de PUT enviada para /api/issues/{projectname} não inclui uma _id, o valor de retorno é { error: 'missing _id' }.

async (getUserInput) => {
  try {
    const url = getUserInput('url') + '/api/issues/fcc-project';
    const badUpdate = await $.ajax({ url: url, type: 'PUT' });
    assert.isObject(badUpdate);
    assert.property(badUpdate, 'error');
    assert.equal(badUpdate.error, 'missing _id');
  } catch (err) {
    throw new Error(err.responseText || err.message);
  }
};

Quando a solicitação de PUT enviada para /api/issues/{projectname} não inclui campos para atualizar, o valor de retorno é { error: 'no update field(s) sent', '_id': _id }. Em qualquer outro erro, o valor de retorno é { error: 'could not update', '_id': _id }.

async (getUserInput) => {
  try {
    const url = getUserInput('url') + '/api/issues/fcc-project';
    const badUpdate = await $.ajax({
      url: url,
      type: 'PUT',
      data: { _id: '5f665eb46e296f6b9b6a504d' }
    });
    assert.deepEqual(badUpdate, {
      error: 'no update field(s) sent',
      _id: '5f665eb46e296f6b9b6a504d'
    });
    const badIdUpdate = await $.ajax({
      url: url,
      type: 'PUT',
      data: { _id: '5f665eb46e296f6b9b6a504d', issue_text: 'New Issue Text' }
    });
    assert.deepEqual(badIdUpdate, {
      error: 'could not update',
      _id: '5f665eb46e296f6b9b6a504d'
    });
  } catch (err) {
    throw new Error(err.responseText || err.message);
  }
};

Você pode enviar uma solicitação de DELETE para /api/issues/{projectname} com um _id para excluir uma issue. Se nenhum _id for enviado, o valor de retorno é { error: 'missing _id' }. Em caso de sucesso, o valor de retorno é { result: 'successfully deleted', '_id': _id }. Em qualquer outro erro, o valor de retorno é { error: 'could not delete', '_id': _id }.

async (getUserInput) => {
  try {
    let initialData = {
      issue_title: 'Issue to be Deleted',
      issue_text: 'Functional Test - Delete target',
      created_by: 'fCC'
    };
    const url = getUserInput('url') + '/api/issues/fcc-project';
    const itemToDelete = await $.post(url, initialData);
    assert.isObject(itemToDelete);
    const deleteSuccess = await $.ajax({
      url: url,
      type: 'DELETE',
      data: { _id: itemToDelete._id }
    });
    assert.isObject(deleteSuccess);
    assert.deepEqual(deleteSuccess, {
      result: 'successfully deleted',
      _id: itemToDelete._id
    });
    const noId = await $.ajax({ url: url, type: 'DELETE' });
    assert.isObject(noId);
    assert.deepEqual(noId, { error: 'missing _id' });
    const badIdDelete = await $.ajax({
      url: url,
      type: 'DELETE',
      data: { _id: '5f665eb46e296f6b9b6a504d', issue_text: 'New Issue Text' }
    });
    assert.isObject(badIdDelete);
    assert.deepEqual(badIdDelete, {
      error: 'could not delete',
      _id: '5f665eb46e296f6b9b6a504d'
    });
  } catch (err) {
    throw new Error(err.responseText || err.message);
  }
};

Todos os 14 testes funcionais foram concluídos e deram aprovação.

async (getUserInput) => {
  try {
    const getTests = await $.get(getUserInput('url') + '/_api/get-tests');
    assert.isArray(getTests);
    assert.isAtLeast(getTests.length, 14, 'At least 14 tests passed');
    getTests.forEach((test) => {
      assert.equal(test.state, 'passed', 'Test in Passed State');
      assert.isAtLeast(
        test.assertions.length,
        1,
        'At least one assertion per test'
      );
    });
  } catch (err) {
    throw new Error(err.responseText || err.message);
  }
};

--solutions--

/**
  Backend challenges don't need solutions, 
  because they would need to be tested against a full working project. 
  Please check our contributing guidelines to learn more.
*/